{ "swagger": "2.0", "info": { "description": "The Person REST APIs enable you to access information about the worker person, including country-specific configuration information about name components.", "version": "v4", "title": "person", "x-workday-internal-source": "xo", "x-workday-internal-routing": "Public", "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-service-container-id": "ba74f44bc90e107329f63d467ade0043" }, "host": "", "basePath": "/person/v4", "tags": [ { "name": "countries", "description": "Provides information about countries, including tenant configuration about name components for a specified country." }, { "name": "homeContactInformationChanges", "description": "Enables you to perform a Home Contact Change task. Using these REST APIs, you can get and update home contact information such as address, e-mail address, phone number, web address, and instant messenger.\n\nTo start and submit a home contact change request for a specific person: \n\n1. Initiate a home contact change event by calling a POST request for a role that can use this business process. Example: the POST staffing/workers/{ID}/homeContactInformationChanges operation that returns a new home contact change ID. \n\n2. Update data for the home contact change request by calling operations on the available person/homeContactInformationChanges/{id}/{subresource} endpoints. These allow you to add, update, or remove home contact information. The correct Usage Type to use when doing so is Home, \"836cf00ef5974ac08b786079866c946f\"\n\n3. Submit the home contact change request by calling the POST person/homeContactInformationChanges/{ID}/submit endpoint. The updated data in the preceding home contact change requests don't persist until you call POST person/homeContactInformationChanges/{ID}/submit." }, { "name": "people", "description": "A collection of people in Workday" }, { "name": "phoneValidation", "description": "Provides the ability to perform phone validations." }, { "name": "workContactInformationChanges", "description": "Enables you to perform a Work Contact Change task. Using these REST APIs, you can get and update work contact information such as address, e-mail address, phone number, web address, and instant messenger.\n\nTo start and submit a work contact change request for a specific person: \n\n1. Initiate a work contact change event by calling a POST request for a role that can use this business process. Example: the POST staffing/workers/{ID}/workContactInformationChanges operation that returns a new work contact change ID. \n\n2. Update data for the work contact change request by calling operations on the available person/workContactInformationChanges/{id}/{subresource} endpoints. These allow you to add, update, or remove work contact information. The correct Usage Type to use when doing so is Work, \"1f27f250dfaa4724ab1e1617174281e4\"\n\n3. Submit the work contact change request by calling the POST person/workContactInformationChanges/{ID}/submit endpoint. The updated data in the preceding work contact change requests don't persist until you call POST person/workContactInformationChanges/{ID}/submit." }, { "name": "Prompt Values", "description": "Retrieves instances that can be used as values for other endpoint parameters in this service." } ], "schemes": [ "https" ], "paths": { "/people/{ID}/personalInformation": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of personal information.", "description": "Retrieves all personal information for the person with the specified ID.\n\nSecured By Domain: Person Data: Personal Information, Self-Service: Personal Information\n\nScope: Personal 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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "name": "country", "in": "query", "description": "Specifies the set of personal information by country that will be returned. If empty, the most recently updated set of personal information will be returned.", "required": false, "type": "string" }, { "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/personalInformation_414c4cee7d91100023fe329d6f900018" } } } } }, "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": "cb7f231fa7061000112fadf3ccad017b", "x-workday-secured-by-domains": [ "Person Data: Personal Information", "Self-Service: Personal Information" ] } }, "/phoneValidation": { "post": { "tags": [ "phoneValidation" ], "summary": "Validates phone number data to ensure it is valid for Workday.", "description": "Validates the specified completePhoneNumber in the request body.\nThe completePhoneNumber field is required in the request body.\n\nIf the specified completePhoneNumber is valid, this method returns the 201 response status. If the specified completePhoneNumber is invalid, this method returns the 400 response status with a validation error message. \n\nThis method assumes the Allowed Phone Validations for the country of the phone is enabled on the Tenant Setup - Global configuration.\nIf the tenant configuration has disabled the Allowed Phone Validations for the associated country, the validation returns as valid.\n\nSecured By Domain: REST API Public", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "phoneNumberValidation", "required": true, "schema": { "$ref": "#/definitions/phoneNumberValidation_db1991f2fb091000169c5dfa023800b8" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/phoneNumberValidation_db1991f2fb091000169c5dfa023800b8" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A288 | Enter a phone number in the valid format: [PhoneValidationMessage] |", "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": "db1991f2fb09100016af7e96062c00c0", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/people/{ID}/homeAddresses/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a home address.", "description": "Retrieves a home address for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Address, Self-Service: Home Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/addressReference_9c3ab7b846e4100009e5ec55fa530024" } }, "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": "9c3ab7b846e4100009d3803914040022", "x-workday-secured-by-domains": [ "Person Data: Home Address", "Self-Service: Home Address" ] } }, "/countries/{ID}": { "get": { "tags": [ "countries" ], "summary": "Retrieves information about a country.", "description": "Retrieves information about a country, including their alpha codes, and whether or not they are enabled for address lookup.\n\nSecured By Domain: REST API Public", "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: ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-1_Alpha-2_Code, OPM_Country_Code", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(ISO_3166-1_Alpha-3_Code|ISO_3166-1_Numeric-3_Code|ISO_3166-1_Alpha-2_Code|OPM_Country_Code)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/personCountryViewDefinition_f206795ea40e1000040cc6f5da4f002a" } }, "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": "e739a55496d710001579ebb756201300", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/homeContactInformationChanges/{ID}/webAddresses": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "Retrieve all existing web addresses staged for update by the parent business process", "description": "Retrieve all web addresses staged for update by the parent business process\n\nSecured By Domain: Person Data: Home Web Address, Self-Service: Home Web Address\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary web addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public web addresses.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/webAddressReference_e357ae6d466510000ce259f323be01b0" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100013a6a7196d92011b", "x-workday-secured-by-domains": [ "Person Data: Home Web Address", "Self-Service: Home Web Address" ] }, "post": { "tags": [ "homeContactInformationChanges" ], "summary": "Creates a new web address.", "description": "Creates a new web address staged by the parent business process event.\n\nSecured By Domain: Person Data: Home Web Address, Self-Service: Home Web Address\n\nScope: Contact Information", "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": "webAddressReference", "required": true, "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100013a6a7487846011d", "x-workday-secured-by-domains": [ "Person Data: Home Web Address", "Self-Service: Home Web Address" ] } }, "/people/{ID}/additionalNames/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves an additional name.", "description": "Retrieves an additional name for the person with the specified ID.\n\nSecured By Domain: Person Data: Name, Self-Service: Name\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Excludable_Name", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Excludable_Name)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/name_33e26848dc0010002f1ae76d63ec0061" } }, "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": "cb7f231fa70610000498c41ac1a40177", "x-workday-secured-by-domains": [ "Person Data: Name", "Self-Service: Name" ] } }, "/workContactInformationChanges/{ID}/phoneNumbers/{subresourceID}": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "A phone number as it exists staged for update by the parent business process.", "description": "Retrieve an existing phone number as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Work Phone, Self-Service: Work Phone\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001447598c53f6013d", "x-workday-secured-by-domains": [ "Person Data: Work Phone", "Self-Service: Work Phone" ] }, "delete": { "tags": [ "workContactInformationChanges" ], "summary": "Removes the specified phone number.", "description": "Remove the specified phone number. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Work Phone, Self-Service: Work Phone\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A582 | Primary Phone can't be deleted when there are additional phones. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c825501000144759b669fd0140", "x-workday-secured-by-domains": [ "Person Data: Work Phone", "Self-Service: Work Phone" ] }, "patch": { "tags": [ "workContactInformationChanges" ], "summary": "Partially update an existing phone number.", "description": "Partially update an existing phone number that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Work Phone, Self-Service: Work Phone\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" }, { "in": "body", "name": "phoneReference", "required": true, "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c82550100014475998a962013e", "x-workday-secured-by-domains": [ "Person Data: Work Phone", "Self-Service: Work Phone" ] } }, "/values/nameComponents/hereditary/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/people/{ID}/audioNamePronunciation": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of Audio Name Pronunciations", "description": "Retrieves all Audio Name Pronunciations of a Person\n\nSecured By Domain: Person Data: Name Pronunciation\n\nScope: Personal 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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "name": "currentAudio", "in": "query", "description": "Download only the currently active audio", "required": false, "type": "boolean" }, { "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/mediaDownload_5d5f0fb1184b10000b16f0e5c20f0000" } } } } }, "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": "70aaa4de71b4100020164c46ea190000", "x-workday-secured-by-domains": [ "Person Data: Name Pronunciation" ] } }, "/people/{ID}/personalInformation/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a person's personal information.", "description": "Retrieves personal information for the person with the specified ID.\n\nSecured By Domain: Person Data: Personal Information, Self-Service: Personal Information\n\nScope: Personal 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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/personalInformation_414c4cee7d91100023fe329d6f900018" } }, "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": "cb7f231fa7061000112fadf3ccad017b", "x-workday-secured-by-domains": [ "Person Data: Personal Information", "Self-Service: Personal Information" ] } }, "/workContactInformationChanges/{ID}/instantMessengers/{subresourceID}": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "An instant messenger as it exists staged for update by the parent business process.", "description": "Retrieve an existing instant messenger as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c8255010001479a05aa0e9014d", "x-workday-secured-by-domains": [ "Person Data: Work Instant Messenger", "Self-Service: Work Instant Messenger" ] }, "delete": { "tags": [ "workContactInformationChanges" ], "summary": "Remove the specified instant messenger.", "description": "Remove the specified instant messenger. If this instant messenger existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A579 | Primary Instant Messenger Account can't be deleted when there are additional Instant Messenger Accounts. |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c8255010001479a07351ce014f", "x-workday-secured-by-domains": [ "Person Data: Work Instant Messenger", "Self-Service: Work Instant Messenger" ] }, "patch": { "tags": [ "workContactInformationChanges" ], "summary": "Partially update an existing instant messenger.", "description": "Partially update an existing instant messenger that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" }, { "in": "body", "name": "instantMessengerReference", "required": true, "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c8255010001479a04b5d11014c", "x-workday-secured-by-domains": [ "Person Data: Work Instant Messenger", "Self-Service: Work Instant Messenger" ] } }, "/homeContactInformationChanges/{ID}": { "get": { "tags": [ "homeContactInformationChanges" ], "description": "Returns basic information about the home contact change event.\n\nSecured By Domain: Person Data: Home Contact Information, Self-Service: Home Contact Information\n\nSecured By Business Process Type: Home Contact Change\n\nScope: Contact Information", "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/changeContactInformationEvent_765b18aa13af1000064a10bf37b800ed" } }, "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": "0f7b29931b0f10001a069deb3ae40120", "x-workday-secured-by-domains": [ "Person Data: Home Contact Information", "Self-Service: Home Contact Information" ], "x-workday-secured-by-business-process-types": [ "Home Contact Change" ] } }, "/homeContactInformationChanges/{ID}/phoneNumbers": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "Retrieve all existing phone numbers staged for update by the parent business process", "description": "Retrieve all phone numbers staged for update by the parent business process\n\nSecured By Domain: Person Data: Home Phone, Self-Service: Home Phone\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary phone numbers.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public phone numbers.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/phoneReference_1089da0ab90910000f70891a998b0887" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001374d2dbbf1f0112", "x-workday-secured-by-domains": [ "Person Data: Home Phone", "Self-Service: Home Phone" ] }, "post": { "tags": [ "homeContactInformationChanges" ], "summary": "Creates a new phone number.", "description": "Creates a new phone number staged by the parent business process event.\n\nSecured By Domain: Person Data: Home Phone, Self-Service: Home Phone\n\nScope: Contact Information", "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": "phoneReference", "required": true, "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001374d2c2cd74010f", "x-workday-secured-by-domains": [ "Person Data: Home Phone", "Self-Service: Home Phone" ] } }, "/people/{ID}/photos": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of personal photos.", "description": "Retrieves all personal photos for the person with the specified ID.\n\nSecured By Domain: Person Data: Personal Photo, Self-Service: Personal Photo\n\nScope: Personal Data\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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/personPhoto_6b9baf67ce60100007d43c79e7a30011" } } } } }, "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": "6b9baf67ce60100007d70daf0b220013", "x-workday-secured-by-domains": [ "Person Data: Personal Photo", "Self-Service: Personal Photo" ] } }, "/workContactInformationChanges/{ID}/submit": { "post": { "tags": [ "workContactInformationChanges" ], "summary": "Submit the specified contact change ID.", "description": "Submits the specified work contact information change ID. \n\nTo submit the Work Contact Change event and initiate the Work Contact Change business process, specify an empty request body: {}.\nTo save for later, specify this request body:\n{\n \"businessProcessParameters\": {\n \"action\":{\n \"id\": \"d9e41a8c446c11de98360015c5e6daf6\"\n }\n }\n}\n\nThe action id value is the Workday ID of the Save for Later action. If you submit this endpoint with the Save for Later action, you can no longer edit nor resubmit the Work Contact Change event using the REST APIs. The user with correct permissions can edit and submit the saved Work Contact Change event in the Workday UI.\n\nSecured By Business Process Type: Work Contact Change\n\nScope: Contact Information\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).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "in": "body", "name": "jsonData", "required": true, "schema": { "$ref": "#/definitions/changeContactInformationEvent_765b18aa13af1000064a10bf37b800ed" }, "x-workday-multipart-root-part-name": "jsonData" } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/changeContactInformationEvent_765b18aa13af1000064a10bf37b800ed" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A165 | The attachment category is invalid for this business process. |\n| Critical | A175 | The file is required. |\n| Critical | A178 | The business process has already been initiated. |\n| Critical | A200 | You can't comment on this business process type. |\n| Critical | A205 | You don't have the security permission on this business process to add attachments. |\n| Critical | A206 | Attachments are not enabled for this business process. |\n| Critical | A207 | You've exceeded the attachment file size limit of [tenant setup attachment limit]KB. |\n| Critical | A211 | The attachment category is required. |\n| Critical | A219 | The business process action isn't valid. |\n| Critical | A221 | The attachment category isn't enabled for this business process. |\n| Critical | A228 | [customer event validation message] |\n| Critical | A665 | You can't submit this event because it is a sub-event. |\n| Critical | A3291 | You must have the delegation permission to initiate this event. Ensure that you have all the required permissions and configuration for this action. |", "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": "eef3c5af9bca10001bb68becb0b102dd", "x-workday-secured-by-business-process-types": [ "Work Contact Change" ] } }, "/values/nameComponents/religious/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/values/nameComponents/honorary/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/people/{ID}/preferredName": { "get": { "tags": [ "people" ], "summary": "Retrieves the preferred name instance.", "description": "Retrieves the preferred name for the person with the specified ID.\n\nSecured By Domain: Person Data: Preferred Name, Self-Service: Preferred Name\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/name_33e26848dc0010002f1ae76d63ec0061" } } } } }, "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": "cb7f231fa706100004719e2ce3600172", "x-workday-secured-by-domains": [ "Person Data: Preferred Name", "Self-Service: Preferred Name" ] } }, "/values/nameComponents/royal/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/workContactInformationChanges/{ID}": { "get": { "tags": [ "workContactInformationChanges" ], "description": "Returns basic information about the work contact change event, as well as the Alternate Work Location staged by the event, if there is one.\n\nSecured By Domain: Person Data: Work Contact Information, Self-Service: Work Contact Information\n\nSecured By Business Process Type: Work Contact Change\n\nScope: Contact Information", "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/workContactChangeEventView_bdfa2c83ea5e10002b70a7e9f69e5d67" } }, "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": "0f7b29931b0f10001a4e29f584c80129", "x-workday-secured-by-domains": [ "Person Data: Work Contact Information", "Self-Service: Work Contact Information" ], "x-workday-secured-by-business-process-types": [ "Work Contact Change" ] }, "patch": { "tags": [ "workContactInformationChanges" ], "description": "Update the Alternate Work Location staged by this business process event. Any Home or Work address for the target Person is valid for use as an Alternate Work Location.\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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": "workContactChangeEvent", "required": true, "schema": { "$ref": "#/definitions/workContactChangeEvent_d72a8353f91e1000169a839c31a0046d" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/workContactChangeEvent_d72a8353f91e1000169a839c31a0046d" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A575 | You can only specify a current home or work address as an Alternate Work Location for the subject person. |", "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": "ee7384bade9d1000094a89ef1573001b", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] } }, "/countries/{ID}/addressComponents": { "get": { "tags": [ "countries" ], "summary": "Retrieves the allowed address components and their configuration for the Country and a given Address Configuration Format.\nThe webServiceAlias of the returned address components map to the enterable fields when submitting address data in other POST/PUT/PATCH operations.", "description": "Retrieves the allowed address components and their configuration for the Country and a given Address Configuration Format.\n\nSecured By Domain: REST API Public", "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: ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-1_Alpha-2_Code, OPM_Country_Code", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(ISO_3166-1_Alpha-3_Code|ISO_3166-1_Numeric-3_Code|ISO_3166-1_Alpha-2_Code|OPM_Country_Code)=\\S+)$" }, { "name": "addressConfigurationFormat", "in": "query", "description": "The Address Configuration Format to return values for. \nRequired. Failure to provide this will result in no address components being returned.\nAvailable values are:\n- DEFAULT_AREAS\n- RECRUITING_FORMAT", "required": false, "type": "string" }, { "name": "currentAddress", "in": "query", "description": "The existing address being updated. \nRequired when you use Default Format and a Country using Local Script to get component data for an existing address. Failure to provide this when appropriate may result in incorrect address component data being returned.", "required": false, "type": "string" }, { "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": "useWesternScript", "in": "query", "description": "When applicable, setting this value to false will enable Local Script components only. Local Components that are requireable will be enforced as required. When set to true, Local Script and Western Script components are enabled. Western Script Components that are requireable will be enforced as required.", "required": false, "type": "boolean" } ], "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/personLocalizedAddressComponentFormat_98e46a86842a10000dc277ddefc7027b" } } } } }, "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": "e739a55496d710000da4dbb3f42612e2", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/people/{ID}/photos/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a personal photo.", "description": "Retrieves a personal photo for the person with the specified ID.\n\nSecured By Domain: Person Data: Personal Photo, Self-Service: Personal Photo\n\nScope: Personal Data\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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Image_ID, File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Image_ID|File_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/personPhoto_6b9baf67ce60100007d43c79e7a30011" } }, "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": "6b9baf67ce60100007d70daf0b220013", "x-workday-secured-by-domains": [ "Person Data: Personal Photo", "Self-Service: Personal Photo" ] } }, "/people/{ID}/workInstantMessengers": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of work instant messenger accounts usernames.", "description": "Retrieves all work instant messenger account usernames for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary instant messenger account usernames.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public instant messenger usernames.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/instantMessengerAccount_33e26848dc00100036f723337ebb0132" } } } } }, "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": "df014bc8b5fa10001256036ef15d0126", "x-workday-secured-by-domains": [ "Person Data: Work Instant Messenger", "Self-Service: Work Instant Messenger" ] } }, "/people/{ID}/legalName/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves the legal name instance.", "description": "Retrieves the legal name for the person with the specified ID.\n\nSecured By Domain: Person Data: Legal Name, Self-Service: Legal Name\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Excludable_Name", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Excludable_Name)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/name_33e26848dc0010002f1ae76d63ec0061" } }, "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": "cb7f231fa7061000041bc2567bc4016e", "x-workday-secured-by-domains": [ "Person Data: Legal Name", "Self-Service: Legal Name" ] } }, "/homeContactInformationChanges/{ID}/emailAddresses": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "Retrieve all existing addresses staged for update by the parent business process", "description": "Retrieve all email addresses staged for update by the parent business process\n\nSecured By Domain: Person Data: Home Email, Self-Service: Home Email\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary email addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public email addresses.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001347feab42a60107", "x-workday-secured-by-domains": [ "Person Data: Home Email", "Self-Service: Home Email" ] }, "post": { "tags": [ "homeContactInformationChanges" ], "summary": "Creates a new email address.", "description": "Creates a new email address staged by the parent business process event.\n\nSecured By Domain: Person Data: Home Email, Self-Service: Home Email\n\nScope: Contact Information", "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": "emailAddressReference", "required": true, "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001347fe8c2d240104", "x-workday-secured-by-domains": [ "Person Data: Home Email", "Self-Service: Home Email" ] } }, "/people/{ID}/workEmails": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of work email addresses.", "description": "Retrieves all work email addresses for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Email, Self-Service: Work Email\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary email addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public email addresses.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/emailReference_9c3ab7b846e41000327e788d9664012a" } } } } }, "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": "df014bc8b5fa10000a2681bc9c9b00cc", "x-workday-secured-by-domains": [ "Person Data: Work Email", "Self-Service: Work Email" ] } }, "/people/{ID}/homeAddresses": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of home addresses.", "description": "Retrieves all home addresses for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Address, Self-Service: Home Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "name": "effective", "in": "query", "description": "The effective date of the person's addresses using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public addresses.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/addressReference_9c3ab7b846e4100009e5ec55fa530024" } } } } }, "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": "9c3ab7b846e4100009d3803914040022", "x-workday-secured-by-domains": [ "Person Data: Home Address", "Self-Service: Home Address" ] } }, "/people/{ID}/homePhones/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a home phone number.", "description": "Retrieves a home phone number for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Phone, Self-Service: Home Phone\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/phoneReference_df014bc8b5fa10000af0fe7cb0ab00dd" } }, "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": "df014bc8b5fa10000ae4d81e03bd00db", "x-workday-secured-by-domains": [ "Person Data: Home Phone", "Self-Service: Home Phone" ] } }, "/workContactInformationChanges/{ID}/instantMessengers": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "Retrieve all existing instant messengers staged for update by the parent business process", "description": "Retrieve all instant messengers staged for update by the parent business process\n\nSecured By Domain: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary instant messenger account usernames.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public instant messenger account usernames.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c8255010001479a05aa0e9014d", "x-workday-secured-by-domains": [ "Person Data: Work Instant Messenger", "Self-Service: Work Instant Messenger" ] }, "post": { "tags": [ "workContactInformationChanges" ], "summary": "Creates a new instant messenger.", "description": "Creates a new instant messenger staged by the parent business process event.\n\nSecured By Domain: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger\n\nScope: Contact Information", "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": "instantMessengerReference", "required": true, "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c8255010001479a05f4f36014e", "x-workday-secured-by-domains": [ "Person Data: Work Instant Messenger", "Self-Service: Work Instant Messenger" ] } }, "/values/nameComponents/title/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/countries/{ID}/nameComponents": { "get": { "tags": [ "countries" ], "summary": "Retrieves a collection of configuration information about name components.", "description": "Retrieves a collection of configuration information about name components. The Maintain Name Components by Country task enables administrators to configure the allowed and required name components for a country. \n\nYou must specify the required nameConfigurationFormat query parameter.\n\nSecured By Domain: REST API Public", "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: ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-1_Alpha-2_Code, OPM_Country_Code", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(ISO_3166-1_Alpha-3_Code|ISO_3166-1_Numeric-3_Code|ISO_3166-1_Alpha-2_Code|OPM_Country_Code)=\\S+)$" }, { "name": "currentName", "in": "query", "description": "The Workday ID of the person's current name being updated. \nRequired when you use Default Format and a Country using Local Script to get component data for an existing name. Failure to provide this when appropriate may result in incorrect name component data being returned.", "required": false, "type": "string" }, { "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": "nameConfigurationFormat", "in": "query", "description": "The Name Configuration Format for which to return values. \nRequired. Failure to provide this will result in no name components being returned.\nAvailable values are:\n- RECRUITING_FORMAT - The name components specific to Recruiting.\n- OTHER_FUNCTIONAL_AREAS - The name components for all other functional areas in Workday.\nExample: nameConfigurationFormat=Name_Configuration_Format_ID=OTHER_FUNCTIONAL_AREAS", "required": false, "type": "string" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "useWesternScript", "in": "query", "description": "When applicable, setting this value to false will enable Local Script components only. Local Components that are requireable will be enforced as required. When set to true, Local Script and Western Script components are enabled. Western Script Components that are requireable will be enforced as required.", "required": false, "type": "boolean" } ], "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/personLocalizedNameComponentFormat_51f9e585eec710001050c68b768b00ea" } } } } }, "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": "51f9e585eec710001052abe8134700ec", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/people/{ID}/workInstantMessengers/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a work instant messenger account username.", "description": "Retrieves a work instant messenger account username for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/instantMessengerAccount_33e26848dc00100036f723337ebb0132" } }, "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": "df014bc8b5fa10001256036ef15d0126", "x-workday-secured-by-domains": [ "Person Data: Work Instant Messenger", "Self-Service: Work Instant Messenger" ] } }, "/people/{ID}/workAddresses/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a work address.", "description": "Retrieves a work address for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/addressReference_9c3ab7b846e4100009e5ec55fa530024" } }, "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": "9c3ab7b846e41000314d15d69716010f", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] } }, "/homeContactInformationChanges/{ID}/addresses": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "Retrieve all existing addresses staged for update by the parent business process", "description": "Retrieve all addresses staged for update by the parent business process\n\nSecured By Domain: Person Data: Home Address, Self-Service: Home Address\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "required": false, "type": "string" } ], "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/homeAddressReference_81f66ab16f7510005c53d881876e4843" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A570 | Only one address of type work from home is allowed. |\n| Critical | A574 | Enter a number from 0 to 7 for work from home days. |\n| Critical | A593 | Number of Days can only be set on an address marked Work From Home |\n| Critical | A657 | Number of Days is not allowed for the country specified. |", "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": "81f66ab16f7510005c74ddda48e8487c", "x-workday-secured-by-domains": [ "Person Data: Home Address", "Self-Service: Home Address" ] }, "post": { "tags": [ "homeContactInformationChanges" ], "description": "Creates a new address staged by the parent business process event.\n\nSecured By Domain: Person Data: Home Address, Self-Service: Home Address\n\nScope: Contact Information", "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": "homeAddressReference", "required": true, "schema": { "$ref": "#/definitions/homeAddressReference_81f66ab16f7510005c53d881876e4843" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/homeAddressReference_81f66ab16f7510005c53d881876e4843" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A570 | Only one address of type work from home is allowed. |\n| Critical | A574 | Enter a number from 0 to 7 for work from home days. |\n| Critical | A584 | Only one [type] Address can be marked as Primary. |\n| Critical | A592 | Enter a city that is part of the region you entered. |\n| Critical | A593 | Number of Days can only be set on an address marked Work From Home |\n| Critical | A597 | Enter a region that is part of the country you entered. |\n| Critical | A599 | You can't change the Usage Type of an existing address. |\n| Critical | A613 | You can't change a primary address to an additional address or an additional address to a primary address. |\n| Critical | A616 | You must enter a country. |\n| Critical | A626 | Only one address of type International Assignment is allowed for a \\~country\\~. |\n| Critical | A636 | Invalid Usage Behavior(s): [cubt]. |\n| Critical | A637 | Home addresses cannot be made public. |\n| Critical | A640 | The country for this address requires that you enter the city name as text rather than select it. |\n| Critical | A642 | Submitted fields aren't enabled for [proposed country]: [invalid proposed fields]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A653 | The following address Usage Behaviors are inactive: [cubt]. |\n| Critical | A654 | The country for this address requires that you select a specific city instance rather than enter text. |\n| Critical | A657 | Number of Days is not allowed for the country specified. |\n| Critical | A661 | Invalid Usage Behavior(s) for Address: [cub]. |\n| Critical | A662 | Missing fields are required for [proposed country]: [missing required fields]. |\n| Critical | A663 | Invalid Usage Type [type] and Use For [usedFor] combination for Address |\n| Critical | A666 | You can't enter a Primary Address with a usage of International Assignment. |\n| Critical | A950 | [postal code] is not a valid postal code for [region]. |\n| Critical | A951 | Enter a postal code in the valid format: [PostalCodeValidationMessage] |", "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": "81f66ab16f75100063ae2e16a6c1501d", "x-workday-secured-by-domains": [ "Person Data: Home Address", "Self-Service: Home Address" ] } }, "/homeContactInformationChanges/{ID}/instantMessengers/{subresourceID}": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "An instant messenger as it exists staged for update by the parent business process.", "description": "Retrieve an existing instant messenger as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c82550100013c373bc13e80125", "x-workday-secured-by-domains": [ "Person Data: Home Instant Messenger", "Self-Service: Home Instant Messenger" ] }, "delete": { "tags": [ "homeContactInformationChanges" ], "summary": "Remove the specified instant messenger.", "description": "Remove the specified instant messenger. If this instant messenger existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A579 | Primary Instant Messenger Account can't be deleted when there are additional Instant Messenger Accounts. |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c82550100013c3741530490127", "x-workday-secured-by-domains": [ "Person Data: Home Instant Messenger", "Self-Service: Home Instant Messenger" ] }, "patch": { "tags": [ "homeContactInformationChanges" ], "summary": "Partially update an existing instant messenger.", "description": "Partially update an existing instant messenger that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" }, { "in": "body", "name": "instantMessengerReference", "required": true, "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c82550100013c37402481a0126", "x-workday-secured-by-domains": [ "Person Data: Home Instant Messenger", "Self-Service: Home Instant Messenger" ] } }, "/values/commonPhone/countryPhoneCodes/": { "get": { "tags": [ "Prompt Values" ], "description": "Exposes prompting for country phone codes, which are used during the collection of phone numbers.\n\nSecured By Domain: REST API Public", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/countryPhoneCodes_7d0f2c61404910000d78252c4e6d0000" } }, "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" } ], "x-workday-secured-by-domains": [ "REST API Public" ] }, "/people/{ID}/workPhones": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of work phone numbers.", "description": "Retrieves all work phone numbers for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Phone, Self-Service: Work Phone\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary phone numbers.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public phone numbers.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/phoneReference_df014bc8b5fa10000af0fe7cb0ab00dd" } } } } }, "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": "df014bc8b5fa10000c0fda7f77060108", "x-workday-secured-by-domains": [ "Person Data: Work Phone", "Self-Service: Work Phone" ] } }, "/values/countryComponents/countryCity/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: REST API Public", "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": "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-secured-by-domains": [ "REST API Public" ] }, "/homeContactInformationChanges/{ID}/webAddresses/{subresourceID}": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "A web address as it exists staged for update by the parent business process.", "description": "Retrieve an existing web address as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Home Web Address, Self-Service: Home Web Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100013a6a7196d92011b", "x-workday-secured-by-domains": [ "Person Data: Home Web Address", "Self-Service: Home Web Address" ] }, "delete": { "tags": [ "homeContactInformationChanges" ], "summary": "Remove the specified web address.", "description": "Remove the specified web address. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Home Web Address, Self-Service: Home Web Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A600 | Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100013a6a710fc41011a", "x-workday-secured-by-domains": [ "Person Data: Home Web Address", "Self-Service: Home Web Address" ] }, "patch": { "tags": [ "homeContactInformationChanges" ], "summary": "Partially update an existing web address.", "description": "Partially update an existing web address that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Home Web Address, Self-Service: Home Web Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" }, { "in": "body", "name": "webAddressReference", "required": true, "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100013a6a7446513011c", "x-workday-secured-by-domains": [ "Person Data: Home Web Address", "Self-Service: Home Web Address" ] } }, "/values/nameComponents/salutation/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/people/{ID}/audioNamePronunciation/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves an Audio Name Pronunciation", "description": "Retrieves a Audio Name Pronunciation of a Person\n\nSecured By Domain: Person Data: Name Pronunciation\n\nScope: Personal 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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/mediaDownload_5d5f0fb1184b10000b16f0e5c20f0000" } }, "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": "70aaa4de71b4100020164c46ea190000", "x-workday-secured-by-domains": [ "Person Data: Name Pronunciation" ] } }, "/people/{ID}/workWebAddresses/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a work web address.", "description": "Retrieves a work web address for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Web Address, Self-Service: Work Web Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/webAddress_33e26848dc0010003893a0202ced0165" } }, "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": "df014bc8b5fa100013bf4a51750d0142", "x-workday-secured-by-domains": [ "Person Data: Work Web Address", "Self-Service: Work Web Address" ] } }, "/homeContactInformationChanges/{ID}/phoneNumbers/{subresourceID}": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "A phone number as it exists staged for update by the parent business process.", "description": "Retrieve an existing phone number as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Home Phone, Self-Service: Home Phone\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001374d2dbbf1f0112", "x-workday-secured-by-domains": [ "Person Data: Home Phone", "Self-Service: Home Phone" ] }, "delete": { "tags": [ "homeContactInformationChanges" ], "summary": "Removes the specified phone number.", "description": "Remove the specified phone number. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Home Phone, Self-Service: Home Phone\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A582 | Primary Phone can't be deleted when there are additional phones. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001374d2d5fe760111", "x-workday-secured-by-domains": [ "Person Data: Home Phone", "Self-Service: Home Phone" ] }, "patch": { "tags": [ "homeContactInformationChanges" ], "summary": "Partially update an existing phone number.", "description": "Partially update an existing phone number that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Home Phone, Self-Service: Home Phone\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" }, { "in": "body", "name": "phoneReference", "required": true, "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001374d2cf69600110", "x-workday-secured-by-domains": [ "Person Data: Home Phone", "Self-Service: Home Phone" ] } }, "/values/maritalStatus/activeMartialStatuses/": { "get": { "tags": [ "Prompt Values" ], "description": "Marital Statuses that are Active and configured for the Country or Country Region.\n\nSecured By Domain: REST API Public", "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": "countryOrRegion", "in": "query", "description": "The Country or Country Region to retrieve Marital Status values for.", "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", "x-workday-secured-by-domains": [ "REST API Public" ] }, "/people/{ID}/publicContactInformation/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a person's public contact information.", "description": "Retrieves public contact information for the person with the specified ID.\n\nSecured By Domain: REST API Public", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/personPublicRepresentation_d8f2aecf3d63100016a77ab413a20235" } }, "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": "d8f2aecf3d63100016a83bef12a50237", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/people/{ID}/homePhones": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of home phone numbers.", "description": "Retrieves all home phone numbers for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Phone, Self-Service: Home Phone\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary phone numbers.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public phone numbers.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/phoneReference_df014bc8b5fa10000af0fe7cb0ab00dd" } } } } }, "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": "df014bc8b5fa10000ae4d81e03bd00db", "x-workday-secured-by-domains": [ "Person Data: Home Phone", "Self-Service: Home Phone" ] } }, "/homeContactInformationChanges/{ID}/submit": { "post": { "tags": [ "homeContactInformationChanges" ], "summary": "Submit the specified contact change ID.", "description": "Submits the specified home contact information change ID. \n\nTo submit the Home Contact Change event and initiate the Home Contact Change business process, specify an empty request body: {}.\nTo save for later, specify this request body:\n{\n \"businessProcessParameters\": {\n \"action\":{\n \"id\": \"d9e41a8c446c11de98360015c5e6daf6\"\n }\n }\n}\n\nThe action id value is the Workday ID of the Save for Later action. If you submit this endpoint with the Save for Later action, you can no longer edit nor resubmit the Home Contact Change event using the REST APIs. The user with correct permissions can edit and submit the saved Home Contact Change event in the Workday UI.\n\nSecured By Business Process Type: Home Contact Change\n\nScope: Contact Information\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).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "in": "body", "name": "jsonData", "required": true, "schema": { "$ref": "#/definitions/changeContactInformationEvent_765b18aa13af1000064a10bf37b800ed" }, "x-workday-multipart-root-part-name": "jsonData" } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/changeContactInformationEvent_765b18aa13af1000064a10bf37b800ed" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A165 | The attachment category is invalid for this business process. |\n| Critical | A175 | The file is required. |\n| Critical | A178 | The business process has already been initiated. |\n| Critical | A200 | You can't comment on this business process type. |\n| Critical | A205 | You don't have the security permission on this business process to add attachments. |\n| Critical | A206 | Attachments are not enabled for this business process. |\n| Critical | A207 | You've exceeded the attachment file size limit of [tenant setup attachment limit]KB. |\n| Critical | A211 | The attachment category is required. |\n| Critical | A219 | The business process action isn't valid. |\n| Critical | A221 | The attachment category isn't enabled for this business process. |\n| Critical | A228 | [customer event validation message] |\n| Critical | A617 | A primary home address is required. Please add a primary home address before submitting. |\n| Critical | A665 | You can't submit this event because it is a sub-event. |\n| Critical | A3291 | You must have the delegation permission to initiate this event. Ensure that you have all the required permissions and configuration for this action. |", "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": "61fd49399784100028ba9e8ba8bb03ad", "x-workday-secured-by-business-process-types": [ "Home Contact Change" ] } }, "/people/{ID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a person in your Workday tenant.", "description": "Retrieves a person with the specified ID. You can use the returned ID from GET /people or GET /workers as the ID of the person whose information you want to retrieve.\n\nSecured By Domain: REST API Public\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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/personRepresentation_e451ce2c8b48100007c312f3f72700b3" } }, "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": "e451ce2c8b4810000801c94a0ab100d9", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/people/{ID}/publicContactInformation": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of public contact information.", "description": "Retrieves all public contact information for the person with the specified ID.\n\nSecured By Domain: REST API Public", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/personPublicRepresentation_d8f2aecf3d63100016a77ab413a20235" } } } } }, "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": "d8f2aecf3d63100016a83bef12a50237", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/values/personalInformationCountry/populatedCountry/": { "get": { "tags": [ "Prompt Values" ], "description": "The set of countries a person has populated with country specific data.\n\nSecured By Domain: Person Data: Personal Information, Self-Service: Personal Information\n\nScope: Personal Data", "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": "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": "person", "in": "query", "required": false, "type": "string" }, { "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-secured-by-domains": [ "Person Data: Personal Information", "Self-Service: Personal Information" ] }, "/values/nameComponents/social/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/people/{ID}/legalName": { "get": { "tags": [ "people" ], "summary": "Retrieves the legal name instance.", "description": "Retrieves the legal name for the person with the specified ID.\n\nSecured By Domain: Person Data: Legal Name, Self-Service: Legal Name\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/name_33e26848dc0010002f1ae76d63ec0061" } } } } }, "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": "cb7f231fa7061000041bc2567bc4016e", "x-workday-secured-by-domains": [ "Person Data: Legal Name", "Self-Service: Legal Name" ] } }, "/values/nameComponents/professional/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/people": { "get": { "tags": [ "people" ], "summary": "Retrieves a person in your Workday tenant.", "description": "Retrieves a person of the specified ID.\nYou can use the returned ID from GET /people or GET /workers as the ID of the person whose information you want to retrieve.\nWhen the person has any person information, for example:home addresses, a hyperlink to the resource of the information will be included in the response.\n\nSecured By Domain: REST API Public\n\nContains attachment(s)", "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" }, { "name": "universal_ID", "in": "query", "description": "The Universal ID of the person you want to retrieve.", "required": false, "type": "string" } ], "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/personRepresentation_e451ce2c8b48100007c312f3f72700b3" } } } } }, "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": "e451ce2c8b4810000801c94a0ab100d9", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/people/{ID}/homeWebAddresses": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of home web addresses.", "description": "Retrieves all home web addresses for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Web Address, Self-Service: Home Web Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary web addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public web addresses.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/webAddress_33e26848dc0010003893a0202ced0165" } } } } }, "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": "df014bc8b5fa1000133591574f2b0136", "x-workday-secured-by-domains": [ "Person Data: Home Web Address", "Self-Service: Home Web Address" ] } }, "/people/{ID}/preferredName/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves the preferred name instance.", "description": "Retrieves the preferred name for the person with the specified ID.\n\nSecured By Domain: Person Data: Preferred Name, Self-Service: Preferred Name\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Excludable_Name", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Excludable_Name)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/name_33e26848dc0010002f1ae76d63ec0061" } }, "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": "cb7f231fa706100004719e2ce3600172", "x-workday-secured-by-domains": [ "Person Data: Preferred Name", "Self-Service: Preferred Name" ] } }, "/homeContactInformationChanges/{ID}/instantMessengers": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "Retrieve all existing instant messengers staged for update by the parent business process", "description": "Retrieve all instant messengers staged for update by the parent business process\n\nSecured By Domain: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary instant messenger account usernames.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public instant messenger account usernames.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c82550100013c373bc13e80125", "x-workday-secured-by-domains": [ "Person Data: Home Instant Messenger", "Self-Service: Home Instant Messenger" ] }, "post": { "tags": [ "homeContactInformationChanges" ], "summary": "Creates a new instant messenger.", "description": "Creates a new instant messenger staged by the parent business process event.\n\nSecured By Domain: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger\n\nScope: Contact Information", "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": "instantMessengerReference", "required": true, "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A580 | Invalid Usage Type [type] and Use For [usedFor] combination for Instant Messenger |\n| Critical | A585 | You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger |\n| Critical | A598 | You must provide an Instant Messenger Type. |\n| Critical | A603 | You must provide an Instant Messenger Address. |\n| Critical | A606 | Subject person must have exactly one primary [type] Instant Messenger in order to have non-primary entries. |\n| Critical | A607 | Only one [type] Instant Messenger can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A647 | You can't change the Usage Type of an existing Instant Messenger |", "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": "5f06a5c82550100013c373abbf930124", "x-workday-secured-by-domains": [ "Person Data: Home Instant Messenger", "Self-Service: Home Instant Messenger" ] } }, "/values/countryComponents/country/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: REST API Public", "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" } ], "x-workday-secured-by-domains": [ "REST API Public" ] }, "/values/nameComponents/academic/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Person Data: Name\n\nScope: Contact Information", "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": "country", "in": "query", "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-secured-by-domains": [ "Person Data: Name" ] }, "/workContactInformationChanges": { "get": { "tags": [ "workContactInformationChanges" ], "description": "Returns basic information about the work contact change event, as well as the Alternate Work Location staged by the event, if there is one.\n\nSecured By Domain: Person Data: Work Contact Information, Self-Service: Work Contact Information\n\nSecured By Business Process Type: Work Contact Change\n\nScope: Contact Information", "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/workContactChangeEventView_bdfa2c83ea5e10002b70a7e9f69e5d67" } } } } }, "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": "0f7b29931b0f10001a4e29f584c80129", "x-workday-secured-by-domains": [ "Person Data: Work Contact Information", "Self-Service: Work Contact Information" ], "x-workday-secured-by-business-process-types": [ "Work Contact Change" ] } }, "/people/{ID}/additionalNames": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of additional names.", "description": "Retrieves all additional names for the person with the specified ID.\n\nSecured By Domain: Person Data: Name, Self-Service: Name\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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/name_33e26848dc0010002f1ae76d63ec0061" } } } } }, "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": "cb7f231fa70610000498c41ac1a40177", "x-workday-secured-by-domains": [ "Person Data: Name", "Self-Service: Name" ] } }, "/people/{ID}/workAddresses": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of work addresses.", "description": "Retrieves all work addresses for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "name": "effective", "in": "query", "description": "The effective date of the person's addresses using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public addresses.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/addressReference_9c3ab7b846e4100009e5ec55fa530024" } } } } }, "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": "9c3ab7b846e41000314d15d69716010f", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] } }, "/homeContactInformationChanges": { "get": { "tags": [ "homeContactInformationChanges" ], "description": "Returns basic information about the home contact change event.\n\nSecured By Domain: Person Data: Home Contact Information, Self-Service: Home Contact Information\n\nSecured By Business Process Type: Home Contact Change\n\nScope: Contact Information", "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/changeContactInformationEvent_765b18aa13af1000064a10bf37b800ed" } } } } }, "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": "0f7b29931b0f10001a069deb3ae40120", "x-workday-secured-by-domains": [ "Person Data: Home Contact Information", "Self-Service: Home Contact Information" ], "x-workday-secured-by-business-process-types": [ "Home Contact Change" ] } }, "/people/{ID}/workWebAddresses": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of work web addresses.", "description": "Retrieves all work web addresses for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Web Address, Self-Service: Work Web Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary web addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public web addresses.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/webAddress_33e26848dc0010003893a0202ced0165" } } } } }, "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": "df014bc8b5fa100013bf4a51750d0142", "x-workday-secured-by-domains": [ "Person Data: Work Web Address", "Self-Service: Work Web Address" ] } }, "/people/{ID}/homeEmails/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a home email address.", "description": "Retrieve a home email address for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Email, Self-Service: Home Email\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/emailReference_9c3ab7b846e41000327e788d9664012a" } }, "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": "9c3ab7b846e410003265777c35390128", "x-workday-secured-by-domains": [ "Person Data: Home Email", "Self-Service: Home Email" ] } }, "/people/{ID}/workPhones/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a work phone number.", "description": "Retrieves a work phone number for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Phone, Self-Service: Work Phone\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Phone_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Phone_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/phoneReference_df014bc8b5fa10000af0fe7cb0ab00dd" } }, "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": "df014bc8b5fa10000c0fda7f77060108", "x-workday-secured-by-domains": [ "Person Data: Work Phone", "Self-Service: Work Phone" ] } }, "/workContactInformationChanges/{ID}/webAddresses/{subresourceID}": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "A web address as it exists staged for update by the parent business process.", "description": "Retrieve an existing web address as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Work Web Address, Self-Service: Work Web Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100014591ca777650145", "x-workday-secured-by-domains": [ "Person Data: Work Web Address", "Self-Service: Work Web Address" ] }, "delete": { "tags": [ "workContactInformationChanges" ], "summary": "Remove the specified web address.", "description": "Remove the specified web address. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Work Web Address, Self-Service: Work Web Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A600 | Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100014591cb262b70146", "x-workday-secured-by-domains": [ "Person Data: Work Web Address", "Self-Service: Work Web Address" ] }, "patch": { "tags": [ "workContactInformationChanges" ], "summary": "Partially update an existing web address.", "description": "Partially update an existing web address that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Work Web Address, Self-Service: Work Web Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" }, { "in": "body", "name": "webAddressReference", "required": true, "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100014591c92d5810143", "x-workday-secured-by-domains": [ "Person Data: Work Web Address", "Self-Service: Work Web Address" ] } }, "/people/{ID}/homeInstantMessengers/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a home instant messenger account username.", "description": "Retrieves a home instant messenger account username for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Instant_Messenger_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Instant_Messenger_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/instantMessengerAccount_33e26848dc00100036f723337ebb0132" } }, "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": "df014bc8b5fa1000108b054396ac0117", "x-workday-secured-by-domains": [ "Person Data: Home Instant Messenger", "Self-Service: Home Instant Messenger" ] } }, "/people/{ID}/workEmails/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a work email address.", "description": "Retrieves a work email address for the person with the specified ID.\n\nSecured By Domain: Person Data: Work Email, Self-Service: Work Email\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/emailReference_9c3ab7b846e41000327e788d9664012a" } }, "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": "df014bc8b5fa10000a2681bc9c9b00cc", "x-workday-secured-by-domains": [ "Person Data: Work Email", "Self-Service: Work Email" ] } }, "/homeContactInformationChanges/{ID}/emailAddresses/{subresourceID}": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "An email address as it exists staged for update by the parent business process.", "description": "Retrieve an existing email address as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Home Email, Self-Service: Home Email\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001347feab42a60107", "x-workday-secured-by-domains": [ "Person Data: Home Email", "Self-Service: Home Email" ] }, "delete": { "tags": [ "homeContactInformationChanges" ], "summary": "Removes the specified email address.", "description": "Remove the specified email address. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Home Email, Self-Service: Home Email\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A605 | Primary Email Address can't be deleted when there are additional email addresses. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001347fea097f40106", "x-workday-secured-by-domains": [ "Person Data: Home Email", "Self-Service: Home Email" ] }, "patch": { "tags": [ "homeContactInformationChanges" ], "summary": "Partially update an existing email address.", "description": "Partially update an existing email address that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Home Email, Self-Service: Home Email\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" }, { "in": "body", "name": "emailAddressReference", "required": true, "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001347fe9c1da80105", "x-workday-secured-by-domains": [ "Person Data: Home Email", "Self-Service: Home Email" ] } }, "/values/personalInformationCountry/allowedCountry/": { "get": { "tags": [ "Prompt Values" ], "description": "The set of countries a person is allowed to populated with country specific data.\n\nSecured By Domain: Person Data: Personal Information, Self-Service: Personal Information\n\nScope: Personal Data", "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": "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": "person", "in": "query", "required": false, "type": "string" }, { "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-secured-by-domains": [ "Person Data: Personal Information", "Self-Service: Personal Information" ] }, "/workContactInformationChanges/{ID}/phoneNumbers": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "Retrieve all existing phone numbers staged for update by the parent business process", "description": "Retrieve all phone numbers staged for update by the parent business process\n\nSecured By Domain: Person Data: Work Phone, Self-Service: Work Phone\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary phone numbers.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public phone numbers.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/phoneReference_1089da0ab90910000f70891a998b0887" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001447598c53f6013d", "x-workday-secured-by-domains": [ "Person Data: Work Phone", "Self-Service: Work Phone" ] }, "post": { "tags": [ "workContactInformationChanges" ], "summary": "Creates a new phone number.", "description": "Creates a new phone number staged by the parent business process event.\n\nSecured By Domain: Person Data: Work Phone, Self-Service: Work Phone\n\nScope: Contact Information", "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": "phoneReference", "required": true, "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/phoneReference_1089da0ab90910000f70891a998b0887" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A572 | Subject person must have exactly one primary [type] Phone Number in order to have non-primary entries. |\n| Critical | A576 | Phone Extension is not allowed when device type is [VoIP Device Type] |\n| Critical | A577 | Country Code is required unless the device type is VOIP. |\n| Critical | A578 | A phone number is required. |\n| Critical | A604 | Only one [type] Phone Number can be marked as Primary. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A646 | Invalid Usage Type [type] and Use For [usedFor] combination for Phone |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A652 | Enter a phone number in a valid format: [PhoneValidationMessage] |\n| Critical | A656 | Country Phone Code is not allowed when device type is [VoIP Device Type] |\n| Critical | A658 | You can't change a primary phone to an additional phone or an additional phone to a primary phone. |\n| Critical | A660 | You can't change the Usage Type of an existing phone. |\n| Critical | A664 | The field phone device type is required and must have a value. |", "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": "5f06a5c8255010001447599ef718013f", "x-workday-secured-by-domains": [ "Person Data: Work Phone", "Self-Service: Work Phone" ] } }, "/workContactInformationChanges/{ID}/emailAddresses": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "Retrieve all existing addresses staged for update by the parent business process", "description": "Retrieve all email addresses staged for update by the parent business process\n\nSecured By Domain: Person Data: Work Email, Self-Service: Work Email\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary email addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public email addresses.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001434242f1da9013a", "x-workday-secured-by-domains": [ "Person Data: Work Email", "Self-Service: Work Email" ] }, "post": { "tags": [ "workContactInformationChanges" ], "summary": "Creates a new email address.", "description": "Creates a new email address staged by the parent business process event.\n\nSecured By Domain: Person Data: Work Email, Self-Service: Work Email\n\nScope: Contact Information", "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": "emailAddressReference", "required": true, "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c825501000143424188c610137", "x-workday-secured-by-domains": [ "Person Data: Work Email", "Self-Service: Work Email" ] } }, "/people/{ID}/homeWebAddresses/{subresourceID}": { "get": { "tags": [ "people" ], "summary": "Retrieves a home web address.", "description": "Retrieves a home web address for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Web Address, Self-Service: Home Web Address\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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: Web_Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Web_Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/webAddress_33e26848dc0010003893a0202ced0165" } }, "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": "df014bc8b5fa1000133591574f2b0136", "x-workday-secured-by-domains": [ "Person Data: Home Web Address", "Self-Service: Home Web Address" ] } }, "/workContactInformationChanges/{ID}/emailAddresses/{subresourceID}": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "An email address as it exists staged for update by the parent business process.", "description": "Retrieve an existing email address as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Work Email, Self-Service: Work Email\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001434242f1da9013a", "x-workday-secured-by-domains": [ "Person Data: Work Email", "Self-Service: Work Email" ] }, "delete": { "tags": [ "workContactInformationChanges" ], "summary": "Removes the specified email address.", "description": "Remove the specified email address. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Work Email, Self-Service: Work Email\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A605 | Primary Email Address can't be deleted when there are additional email addresses. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001434242570830139", "x-workday-secured-by-domains": [ "Person Data: Work Email", "Self-Service: Work Email" ] }, "patch": { "tags": [ "workContactInformationChanges" ], "summary": "Partially update an existing email address.", "description": "Partially update an existing email address that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Work Email, Self-Service: Work Email\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Email_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Email_ID)=\\S+)$" }, { "in": "body", "name": "emailAddressReference", "required": true, "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/emailAddressReference_0918d433e86b100018119edc1b8f00f7" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A573 | Only one [type] Email Address can be marked as Primary. |\n| Critical | A609 | Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com. |\n| Critical | A610 | You can't change the Usage Type of an existing email address. |\n| Critical | A618 | Email Address is required. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A625 | Subject person must have exactly one primary [type] email address in order to have non-primary entries. |\n| Critical | A628 | You can't change a primary email to an additional email or an additional email to a primary email. |\n| Critical | A629 | Invalid Usage Type [type] and Use For [usedFor] combination for Email Address |\n| Critical | A645 | A valid Usage Type is required. |", "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": "5f06a5c8255010001434242163c10138", "x-workday-secured-by-domains": [ "Person Data: Work Email", "Self-Service: Work Email" ] } }, "/people/{ID}/homeInstantMessengers": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of home instant messenger account usernames.", "description": "Retrieves all home instant messenger account usernames for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary instant messenger account usernames.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public instant messenger usernames.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/instantMessengerAccount_33e26848dc00100036f723337ebb0132" } } } } }, "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": "df014bc8b5fa1000108b054396ac0117", "x-workday-secured-by-domains": [ "Person Data: Home Instant Messenger", "Self-Service: Home Instant Messenger" ] } }, "/people/{ID}/homeEmails": { "get": { "tags": [ "people" ], "summary": "Retrieves a collection of home email addresses.", "description": "Retrieve all home email addresses for the person with the specified ID.\n\nSecured By Domain: Person Data: Home Email, Self-Service: Home Email\n\nScope: Contact Information", "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- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|me)$" }, { "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": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary email addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public email addresses.", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/emailReference_9c3ab7b846e41000327e788d9664012a" } } } } }, "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": "9c3ab7b846e410003265777c35390128", "x-workday-secured-by-domains": [ "Person Data: Home Email", "Self-Service: Home Email" ] } }, "/workContactInformationChanges/{ID}/webAddresses": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "Retrieve all existing web addresses staged for update by the parent business process", "description": "Retrieve all web addresses staged for update by the parent business process\n\nSecured By Domain: Person Data: Work Web Address, Self-Service: Work Web Address\n\nScope: Contact Information", "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" }, { "name": "primaryOnly", "in": "query", "description": "If true, returns only the IDs of the person's primary web addresses.", "required": false, "type": "boolean" }, { "name": "publicOnly", "in": "query", "description": "If true, returns only the IDs of the person's public web addresses.", "required": false, "type": "boolean" }, { "name": "usageType", "in": "query", "description": "Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.", "required": false, "type": "string" }, { "name": "usedFor", "in": "query", "description": "Specifies usage behavior, such as mailing, billing, or shipping.\nOptional.", "required": false, "type": "string" } ], "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/webAddressReference_e357ae6d466510000ce259f323be01b0" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100014591ca777650145", "x-workday-secured-by-domains": [ "Person Data: Work Web Address", "Self-Service: Work Web Address" ] }, "post": { "tags": [ "workContactInformationChanges" ], "summary": "Creates a new web address.", "description": "Creates a new web address staged by the parent business process event.\n\nSecured By Domain: Person Data: Work Web Address, Self-Service: Work Web Address\n\nScope: Contact Information", "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": "webAddressReference", "required": true, "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/webAddressReference_e357ae6d466510000ce259f323be01b0" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A595 | Invalid HTTP address entered. HTTP addresses must be in one of the following formats:\n - http://...\n - https://... |\n| Critical | A596 | Web Address is required. |\n| Critical | A612 | You can't change a primary web address to an additional web address or an additional web address to a primary web address. |\n| Critical | A620 | Invalid Usage Behavior for [cmb]: [cub]. |\n| Critical | A643 | Invalid Usage Type [type] and Use For [usedFor] combination for Web Address |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A648 | Only one [type] Web Address can be marked as Primary. |\n| Critical | A655 | You can't change the Usage Type of an existing Web Address |\n| Critical | A667 | Subject person must have exactly one primary [type] web address in order to have non-primary entries. |", "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": "5f06a5c82550100014591c9bce8e0144", "x-workday-secured-by-domains": [ "Person Data: Work Web Address", "Self-Service: Work Web Address" ] } }, "/homeContactInformationChanges/{ID}/addresses/{subresourceID}": { "get": { "tags": [ "homeContactInformationChanges" ], "summary": "An address as it exists staged for update by the parent business process.", "description": "Retrieve an existing address as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Home Address, Self-Service: Home Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/homeAddressReference_81f66ab16f7510005c53d881876e4843" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A570 | Only one address of type work from home is allowed. |\n| Critical | A574 | Enter a number from 0 to 7 for work from home days. |\n| Critical | A593 | Number of Days can only be set on an address marked Work From Home |\n| Critical | A657 | Number of Days is not allowed for the country specified. |", "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": "81f66ab16f7510005c74ddda48e8487c", "x-workday-secured-by-domains": [ "Person Data: Home Address", "Self-Service: Home Address" ] }, "put": { "tags": [ "homeContactInformationChanges" ], "description": "Update an existing address that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Home Address, Self-Service: Home Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" }, { "in": "body", "name": "homeAddressReference", "required": true, "schema": { "$ref": "#/definitions/homeAddressReference_81f66ab16f7510005c53d881876e4843" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/homeAddressReference_81f66ab16f7510005c53d881876e4843" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A570 | Only one address of type work from home is allowed. |\n| Critical | A574 | Enter a number from 0 to 7 for work from home days. |\n| Critical | A584 | Only one [type] Address can be marked as Primary. |\n| Critical | A592 | Enter a city that is part of the region you entered. |\n| Critical | A593 | Number of Days can only be set on an address marked Work From Home |\n| Critical | A597 | Enter a region that is part of the country you entered. |\n| Critical | A599 | You can't change the Usage Type of an existing address. |\n| Critical | A613 | You can't change a primary address to an additional address or an additional address to a primary address. |\n| Critical | A616 | You must enter a country. |\n| Critical | A626 | Only one address of type International Assignment is allowed for a \\~country\\~. |\n| Critical | A636 | Invalid Usage Behavior(s): [cubt]. |\n| Critical | A637 | Home addresses cannot be made public. |\n| Critical | A640 | The country for this address requires that you enter the city name as text rather than select it. |\n| Critical | A642 | Submitted fields aren't enabled for [proposed country]: [invalid proposed fields]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A653 | The following address Usage Behaviors are inactive: [cubt]. |\n| Critical | A654 | The country for this address requires that you select a specific city instance rather than enter text. |\n| Critical | A657 | Number of Days is not allowed for the country specified. |\n| Critical | A661 | Invalid Usage Behavior(s) for Address: [cub]. |\n| Critical | A662 | Missing fields are required for [proposed country]: [missing required fields]. |\n| Critical | A663 | Invalid Usage Type [type] and Use For [usedFor] combination for Address |\n| Critical | A666 | You can't enter a Primary Address with a usage of International Assignment. |\n| Critical | A950 | [postal code] is not a valid postal code for [region]. |\n| Critical | A951 | Enter a postal code in the valid format: [PostalCodeValidationMessage] |", "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": "81f66ab16f75100064099a0d762c50b8", "x-workday-secured-by-domains": [ "Person Data: Home Address", "Self-Service: Home Address" ] }, "delete": { "tags": [ "homeContactInformationChanges" ], "description": "Remove the specified address. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Home Address, Self-Service: Home Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A570 | Only one address of type work from home is allowed. |\n| Critical | A574 | Enter a number from 0 to 7 for work from home days. |\n| Critical | A593 | Number of Days can only be set on an address marked Work From Home |\n| Critical | A657 | Number of Days is not allowed for the country specified. |", "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": "81f66ab16f751000640999baf45a50b6", "x-workday-secured-by-domains": [ "Person Data: Home Address", "Self-Service: Home Address" ] } }, "/workContactInformationChanges/{ID}/addresses/{subresourceID}": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "An address as it exists staged for update by the parent business process.", "description": "Retrieve an existing address as it exists when staged by the parent business process.\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/workAddressReference_c1bb9f46f65210002d2fa259a1c10095" } }, "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": "92e7cd36b15e10001776515d0e46001b", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] }, "put": { "tags": [ "workContactInformationChanges" ], "description": "Update an existing address that is staged for update by the parent business process event.\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" }, { "in": "body", "name": "workAddressReference", "required": true, "schema": { "$ref": "#/definitions/workAddressReference_c1bb9f46f65210002d2fa259a1c10095" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/workAddressReference_c1bb9f46f65210002d2fa259a1c10095" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A584 | Only one [type] Address can be marked as Primary. |\n| Critical | A592 | Enter a city that is part of the region you entered. |\n| Critical | A597 | Enter a region that is part of the country you entered. |\n| Critical | A599 | You can't change the Usage Type of an existing address. |\n| Critical | A613 | You can't change a primary address to an additional address or an additional address to a primary address. |\n| Critical | A616 | You must enter a country. |\n| Critical | A626 | Only one address of type International Assignment is allowed for a \\~country\\~. |\n| Critical | A636 | Invalid Usage Behavior(s): [cubt]. |\n| Critical | A637 | Home addresses cannot be made public. |\n| Critical | A640 | The country for this address requires that you enter the city name as text rather than select it. |\n| Critical | A642 | Submitted fields aren't enabled for [proposed country]: [invalid proposed fields]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A653 | The following address Usage Behaviors are inactive: [cubt]. |\n| Critical | A654 | The country for this address requires that you select a specific city instance rather than enter text. |\n| Critical | A661 | Invalid Usage Behavior(s) for Address: [cub]. |\n| Critical | A662 | Missing fields are required for [proposed country]: [missing required fields]. |\n| Critical | A663 | Invalid Usage Type [type] and Use For [usedFor] combination for Address |\n| Critical | A666 | You can't enter a Primary Address with a usage of International Assignment. |\n| Critical | A950 | [postal code] is not a valid postal code for [region]. |\n| Critical | A951 | Enter a postal code in the valid format: [PostalCodeValidationMessage] |\n| Critical | A1075 | You can't create a Primary Work Address. To specify a Primary Work Address, please select an existing address as an Alternate Work Location. |", "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": "2552814059201000036449790d990053", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] }, "delete": { "tags": [ "workContactInformationChanges" ], "description": "Remove the specified address. If this address existed before the start of the current business process, it won't be removed from the target Person until the parent business process completes.\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Address_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Address_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A1076 | You can't delete an additional address used as an Alternate Work Location. Remove it from being an Alternate Work Location first. |", "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": "e24b763590141000128c43197b4d01da", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] } }, "/values/countryComponents/countryRegion/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: REST API Public", "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": "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-secured-by-domains": [ "REST API Public" ] }, "/workContactInformationChanges/{ID}/addresses": { "get": { "tags": [ "workContactInformationChanges" ], "summary": "Retrieve all existing addresses staged for update by the parent business process", "description": "Retrieve all addresses staged for update by the parent business process\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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" }, { "name": "publicOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "usedFor", "in": "query", "required": false, "type": "string" } ], "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/workAddressReference_c1bb9f46f65210002d2fa259a1c10095" } } } } }, "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": "92e7cd36b15e10001776515d0e46001b", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] }, "post": { "tags": [ "workContactInformationChanges" ], "description": "Creates a new address staged by the parent business process event.\n\nSecured By Domain: Person Data: Work Address, Self-Service: Work Address\n\nScope: Contact Information", "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": "workAddressReference", "required": true, "schema": { "$ref": "#/definitions/workAddressReference_c1bb9f46f65210002d2fa259a1c10095" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/workAddressReference_c1bb9f46f65210002d2fa259a1c10095" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A584 | Only one [type] Address can be marked as Primary. |\n| Critical | A592 | Enter a city that is part of the region you entered. |\n| Critical | A597 | Enter a region that is part of the country you entered. |\n| Critical | A599 | You can't change the Usage Type of an existing address. |\n| Critical | A613 | You can't change a primary address to an additional address or an additional address to a primary address. |\n| Critical | A616 | You must enter a country. |\n| Critical | A626 | Only one address of type International Assignment is allowed for a \\~country\\~. |\n| Critical | A636 | Invalid Usage Behavior(s): [cubt]. |\n| Critical | A637 | Home addresses cannot be made public. |\n| Critical | A640 | The country for this address requires that you enter the city name as text rather than select it. |\n| Critical | A642 | Submitted fields aren't enabled for [proposed country]: [invalid proposed fields]. |\n| Critical | A645 | A valid Usage Type is required. |\n| Critical | A651 | This type of a shared communication method is not supported. |\n| Critical | A653 | The following address Usage Behaviors are inactive: [cubt]. |\n| Critical | A654 | The country for this address requires that you select a specific city instance rather than enter text. |\n| Critical | A661 | Invalid Usage Behavior(s) for Address: [cub]. |\n| Critical | A662 | Missing fields are required for [proposed country]: [missing required fields]. |\n| Critical | A663 | Invalid Usage Type [type] and Use For [usedFor] combination for Address |\n| Critical | A666 | You can't enter a Primary Address with a usage of International Assignment. |\n| Critical | A950 | [postal code] is not a valid postal code for [region]. |\n| Critical | A951 | Enter a postal code in the valid format: [PostalCodeValidationMessage] |\n| Critical | A1075 | You can't create a Primary Work Address. To specify a Primary Work Address, please select an existing address as an Alternate Work Location. |", "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": "c1bb9f46f6521000164431106b5e0061", "x-workday-secured-by-domains": [ "Person Data: Work Address", "Self-Service: Work Address" ] } }, "/countries": { "get": { "tags": [ "countries" ], "summary": "Retrieves a collection of information about countries.", "description": "Retrieves a collection of information about countries, including their alpha codes, and whether or not they are enabled for address lookup.\n\nSecured By Domain: REST API Public", "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/personCountryViewDefinition_f206795ea40e1000040cc6f5da4f002a" } } } } }, "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": "e739a55496d710001579ebb756201300", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/values/commonPhone/phoneDeviceTypes/": { "get": { "tags": [ "Prompt Values" ], "description": "Exposes prompting for phone device types, which are used during the collection of phone numbers.\n\nSecured By Domain: REST API Public", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/phoneDeviceTypes_e77ea44df9be100016b9510a45100000" } }, "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" } ], "x-workday-secured-by-domains": [ "REST API Public" ] } }, "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" }, "ResourceIdPathValue_homeContactInformationChanges": {}, "businessProcessParameters_83f6f6b7c38d100009c7ad91dd414a16": { "allOf": [ { "$ref": "#/definitions/businessProcessParameters_83f6f6b7c38d100009c69131dea04a14" }, {} ], "description": "The Action Event instance to be used with businessProcessLinkable linked service representations." }, "changeContactInformationEvent_765b18aa13af1000064a10bf37b800ed": { "allOf": [ { "type": "object", "properties": { "businessProcessParameters": { "$ref": "#/definitions/businessProcessParameters_83f6f6b7c38d100009c7ad91dd414a16" }, "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." } } } ] }, "type_de08a6c876a810000cb2e3dd8853001a": { "allOf": [ { "$ref": "#/definitions/instantMessengerType_e3f4243ada0b10000d441b1688d20087" }, {} ], "description": "The instant messenger account type.", "x-workday-populated-by": { "path": "/values/contactInformation/instantMessengerTypes", "field": "id" } }, "usage_de08a6c876a810000cb2e3d738be0019": { "allOf": [ { "$ref": "#/definitions/contactUsage_1089da0ab90910000fa7748617db0898" }, {} ], "description": "The instant messenger account." }, "instantMessengerReference_de08a6c876a810000cb2e38a1d2a0016": { "allOf": [ { "type": "object", "properties": { "userName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The instant messenger account username.", "x-workday-type": "Text" }, "type": { "$ref": "#/definitions/type_de08a6c876a810000cb2e3dd8853001a" }, "usage": { "$ref": "#/definitions/usage_de08a6c876a810000cb2e3d738be0019" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Instant_Messenger_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_instantMessengers": { "type": "string", "pattern": "^(Instant_Messenger_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "example": "Instant_Messenger_ID=21002" }, "ResourceIdPathValue_instantMessengers": {}, "WorkdayReferenceId_phoneNumbers": { "type": "string", "pattern": "^(Phone_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Phone_ID", "example": "Phone_ID=21002" }, "ResourceIdPathValue_phoneNumbers": {}, "countryPhoneCode_1089da0ab90910000f7089365467088c": { "allOf": [ { "$ref": "#/definitions/countryPhoneCode_1089da0ab90910000f6e4de36f670883" }, {} ], "description": "The country phone code for the phone number.", "x-workday-populated-by": { "path": "/values/contactInformation/countryPhoneCodes", "field": "id" } }, "usage_1089da0ab90910000f70892f2de3088a": { "allOf": [ { "$ref": "#/definitions/contactUsage_1089da0ab90910000fa7748617db0898" }, {} ], "description": "The current phone for the reference." }, "deviceType_1089da0ab90910000f7089256c7b0888": { "allOf": [ { "$ref": "#/definitions/phoneDeviceType_1089da0ab90910000f85ace9e4050892" }, {} ], "description": "The phone device type.", "x-workday-populated-by": { "path": "/values/contactInformation/phoneDeviceTypes", "field": "id" } }, "phoneReference_1089da0ab90910000f70891a998b0887": { "allOf": [ { "type": "object", "properties": { "countryPhoneCode": { "$ref": "#/definitions/countryPhoneCode_1089da0ab90910000f7089365467088c" }, "usage": { "$ref": "#/definitions/usage_1089da0ab90910000f70892f2de3088a" }, "deviceType": { "$ref": "#/definitions/deviceType_1089da0ab90910000f7089256c7b0888" }, "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 extension.", "x-workday-type": "Text" }, "completePhoneNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The complete phone number.", "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." }, "Phone_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_webAddresses": { "type": "string", "pattern": "^(Web_Address_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Web_Address_ID", "example": "Web_Address_ID=21002" }, "ResourceIdPathValue_webAddresses": {}, "usage_e357ae6d466510000ce25a08bfe401b3": { "allOf": [ { "$ref": "#/definitions/contactUsage_1089da0ab90910000fa7748617db0898" }, {} ], "description": "The web address." }, "webAddressReference_e357ae6d466510000ce259f323be01b0": { "allOf": [ { "type": "object", "properties": { "url": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The complete URL address for the web address.", "x-workday-type": "Text" }, "usage": { "$ref": "#/definitions/usage_e357ae6d466510000ce25a08bfe401b3" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Web_Address_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_addresses": { "type": "string", "pattern": "^(Address_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Address_ID", "example": "Address_ID=21002" }, "ResourceIdPathValue_addresses": {}, "countryCity_81f66ab16f7510005c53d89089074844": { "allOf": [ { "$ref": "#/definitions/city_ab827579ee1710002095f51c0e3f0178" }, {} ], "description": "\\~Country\\~ City" }, "country_81f66ab16f7510005c53d8fd5f5b4852": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "\\~Country\\~" }, "countryRegion_81f66ab16f7510005c53d8be2fe44847": { "allOf": [ { "$ref": "#/definitions/region_ab827579ee1710001f7eb5159a9b0170" }, {} ], "description": "Country Region" }, "usage_81f66ab16f7510005c53d917926f4857": { "allOf": [ { "$ref": "#/definitions/homeContactUsage_c1bb9f46f65210002d3c341a5dc400b8" }, {} ], "description": "Address Instance Referenced" }, "homeAddressReference_81f66ab16f7510005c53d881876e4843": { "allOf": [ { "type": "object", "properties": { "citySubdivision2Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 2 - Local", "x-workday-type": "Text" }, "addressLine9": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 9", "x-workday-type": "Text" }, "citySubdivision1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 1 - Local", "x-workday-type": "Text" }, "addressLine8Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 8", "x-workday-type": "Text" }, "addressLine6": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 6", "x-workday-type": "Text" }, "effective": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date this business process takes effect.", "readOnly": true, "x-workday-type": "Date" }, "addressLine3": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 3", "x-workday-type": "Text" }, "postalCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Postal Code", "x-workday-type": "Text" }, "numberDaysWFH": { "type": "integer", "example": "9", "description": "Number of Days WFH", "x-workday-type": "Numeric" }, "addressLine2Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 2", "x-workday-type": "Text" }, "cityLocal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City - Local", "x-workday-type": "Text" }, "addressLine6Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 6", "x-workday-type": "Text" }, "addressLine1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 1", "x-workday-type": "Text" }, "citySubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 1", "x-workday-type": "Text" }, "regionSubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 2", "x-workday-type": "Text" }, "city": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City", "x-workday-type": "Text" }, "addressLine4Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 4", "x-workday-type": "Text" }, "regionSubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 1", "x-workday-type": "Text" }, "addressLine7": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 7", "x-workday-type": "Text" }, "addressLine2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 2", "x-workday-type": "Text" }, "addressLine5": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 5", "x-workday-type": "Text" }, "addressLine9Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 9", "x-workday-type": "Text" }, "addressLine3Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 3", "x-workday-type": "Text" }, "countryCity": { "$ref": "#/definitions/countryCity_81f66ab16f7510005c53d89089074844" }, "addressLine7Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 7", "x-workday-type": "Text" }, "addressLine1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 1", "x-workday-type": "Text" }, "country": { "$ref": "#/definitions/country_81f66ab16f7510005c53d8fd5f5b4852" }, "countryRegion": { "$ref": "#/definitions/countryRegion_81f66ab16f7510005c53d8be2fe44847" }, "addressLine5Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 5", "x-workday-type": "Text" }, "regionSubdivision1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 1 - Local", "x-workday-type": "Text" }, "addressLine4": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 4", "x-workday-type": "Text" }, "usage": { "$ref": "#/definitions/usage_81f66ab16f7510005c53d917926f4857" }, "addressLine8": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 8", "x-workday-type": "Text" }, "citySubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 2", "x-workday-type": "Text" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Address_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_emailAddresses": { "type": "string", "pattern": "^(Email_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Email_ID", "example": "Email_ID=21002" }, "ResourceIdPathValue_emailAddresses": {}, "usage_6333dee5ac2010000c8653405aaa0038": { "allOf": [ { "$ref": "#/definitions/contactUsage_1089da0ab90910000fa7748617db0898" }, {} ], "description": "The current email." }, "emailAddressReference_0918d433e86b100018119edc1b8f00f7": { "allOf": [ { "type": "object", "properties": { "emailAddress": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The email address.", "x-workday-type": "Text" }, "usage": { "$ref": "#/definitions/usage_6333dee5ac2010000c8653405aaa0038" }, "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." }, "Email_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "NamedEntry_people": { "type": "string", "description": "Named entry alias", "enum": [ "me" ] }, "ResourceIdPathValue_people": {}, "ResourceIdPathValue_publicContactInformation": {}, "personPublicRepresentation_d8f2aecf3d63100016a77ab413a20235": { "allOf": [ { "type": "object", "properties": { "webAddresses": { "type": "array", "description": "The public web address references for the person.", "items": { "$ref": "#/definitions/webAddresses_d8f2aecf3d6310001bdd0d6312f202b8" }, "x-workday-type": "Multi-instance" }, "addresses": { "type": "array", "description": "The public address references for the person.", "items": { "$ref": "#/definitions/addresses_d8f2aecf3d63100018c36066efa602a4" }, "x-workday-type": "Multi-instance" }, "emails": { "type": "array", "description": "The public email references for the person.", "items": { "$ref": "#/definitions/emails_d8f2aecf3d63100017e85a350c0b025d" }, "x-workday-type": "Multi-instance" }, "phoneNumbers": { "type": "array", "description": "The public phone number references for the person.", "items": { "$ref": "#/definitions/phoneNumbers_d8f2aecf3d631000181f8325be5d026e" }, "x-workday-type": "Multi-instance" }, "instantMessengers": { "type": "array", "description": "The public instant messenger account references for the person.", "items": { "$ref": "#/definitions/instantMessengers_d8f2aecf3d6310001c2dce8a8c3302dc" }, "x-workday-type": "Multi-instance" } } } ] }, "WorkdayReferenceId_workAddresses": { "type": "string", "pattern": "^(Address_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Address_ID", "example": "Address_ID=21002" }, "ResourceIdPathValue_workAddresses": {}, "countryCity_a58f621b14ee1000146a333da1c900e6": { "allOf": [ { "$ref": "#/definitions/city_ab827579ee1710002095f51c0e3f0178" }, {} ], "description": "Country city for the address." }, "usage_a58f621b14ee100014b01c034eeb00f3": { "allOf": [ { "$ref": "#/definitions/contactUsage_ab827579ee171000211397a6dede017d" }, {} ], "description": "The address." }, "countryRegion_a58f621b14ee100014b01c1cbabe00f4": { "allOf": [ { "$ref": "#/definitions/region_ab827579ee1710001f7eb5159a9b0170" }, {} ], "description": "Country region for the address." }, "country_a58f621b14ee1000146a3350196300e7": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "Country for the address." }, "addressReference_9c3ab7b846e4100009e5ec55fa530024": { "allOf": [ { "type": "object", "properties": { "addressLine4Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 4 for the address.", "x-workday-type": "Text" }, "citySubdivision2Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 2 - Local for the address.", "x-workday-type": "Text" }, "addressLine8Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 8 for the address.", "x-workday-type": "Text" }, "citySubdivision1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 1 - Local for the address.", "x-workday-type": "Text" }, "addressLine1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 1 for the address.", "x-workday-type": "Text" }, "addressLine9": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 9 for the address.", "x-workday-type": "Text" }, "regionSubdivision1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 1 - Local for the address.", "x-workday-type": "Text" }, "addressLine8": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 8 for the address.", "x-workday-type": "Text" }, "addressLine2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 2 for the address.", "x-workday-type": "Text" }, "fullFormattedAddress": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Full Formatted Address", "x-workday-type": "Text" }, "addressLine6Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 6 for the address.", "x-workday-type": "Text" }, "regionSubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 2 for the address.", "x-workday-type": "Text" }, "countryCity": { "$ref": "#/definitions/countryCity_a58f621b14ee1000146a333da1c900e6" }, "addressLine4": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 4 for the address.", "x-workday-type": "Text" }, "postalCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The postal code for the address.", "x-workday-type": "Text" }, "fullFormattedLocalAddress": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Full Formatted Local Address", "x-workday-type": "Text" }, "addressLine1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 1 for the address.", "x-workday-type": "Text" }, "citySubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 1 for the address.", "x-workday-type": "Text" }, "addressLine6": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 6 for the address.", "x-workday-type": "Text" }, "usage": { "$ref": "#/definitions/usage_a58f621b14ee100014b01c034eeb00f3" }, "city": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City for the address.", "x-workday-type": "Text" }, "addressLine3": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 3 for the address.", "x-workday-type": "Text" }, "citySubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 2 for the address.", "x-workday-type": "Text" }, "addressLine9Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 9 for the address.", "x-workday-type": "Text" }, "addressLine7Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 7 for the address.", "x-workday-type": "Text" }, "effective": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The Effective Date for the address.", "readOnly": true, "x-workday-type": "Date" }, "addressLine5": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 5 for the address.", "x-workday-type": "Text" }, "regionSubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 1 for the address.", "x-workday-type": "Text" }, "cityLocal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City - Local for the address.", "x-workday-type": "Text" }, "addressLine2Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 2 for the address.", "x-workday-type": "Text" }, "countryRegion": { "$ref": "#/definitions/countryRegion_a58f621b14ee100014b01c1cbabe00f4" }, "addressLine3Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 3 for the address.", "x-workday-type": "Text" }, "country": { "$ref": "#/definitions/country_a58f621b14ee1000146a3350196300e7" }, "addressLine5Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 5 for the address.", "x-workday-type": "Text" }, "addressLine7": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 7 for the address.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "The id for Address Reference \nExample(s): Address_ID=Sample_Value" }, "Address_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_legalName": { "type": "string", "pattern": "^(Excludable_Name)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Excludable_Name", "example": "Excludable_Name=21002" }, "ResourceIdPathValue_legalName": {}, "salutation_11c67b72c9c610000edf7291ae7b004c": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The salutation from the name." }, "title_11c67b72c9c610000edf72f0b3c5004f": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The prefix from the name." }, "social_11c67b72c9c610000edf72e003d1004e": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The social suffix from the name." }, "hereditary_11c67b72c9c610000edf72cf8506004d": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The hereditary suffix from the name." }, "country_33e26848dc0010002f1ae802adc30074": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "The country from the name." }, "name_33e26848dc0010002f1ae76d63ec0061": { "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" }, "secondaryLast": { "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" }, "salutation": { "$ref": "#/definitions/salutation_11c67b72c9c610000edf7291ae7b004c" }, "primary": { "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 family name.", "x-workday-type": "Text" }, "title": { "$ref": "#/definitions/title_11c67b72c9c610000edf72f0b3c5004f" }, "primaryLocal2": { "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" }, "tertiaryLast": { "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" }, "full": { "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" }, "social": { "$ref": "#/definitions/social_11c67b72c9c610000edf72e003d1004e" }, "firstLocal": { "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" }, "hereditary": { "$ref": "#/definitions/hereditary_11c67b72c9c610000edf72cf8506004d" }, "first": { "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" }, "middleLocal": { "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" }, "firstLocal2": { "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" }, "primaryLocal": { "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" }, "country": { "$ref": "#/definitions/country_33e26848dc0010002f1ae802adc30074" }, "middle": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The middle name from the name.", "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." } } } ] }, "WorkdayReferenceId_homeEmails": { "type": "string", "pattern": "^(Email_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Email_ID", "example": "Email_ID=21002" }, "ResourceIdPathValue_homeEmails": {}, "usage_9c3ab7b846e4100032b68c2b58c80134": { "allOf": [ { "$ref": "#/definitions/contactUsage_ab827579ee171000211397a6dede017d" }, {} ], "description": "The current email." }, "emailReference_9c3ab7b846e41000327e788d9664012a": { "allOf": [ { "type": "object", "properties": { "emailComment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Comment associated with the email.", "x-workday-type": "Text" }, "emailAddress": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The email address.", "x-workday-type": "Text" }, "usage": { "$ref": "#/definitions/usage_9c3ab7b846e4100032b68c2b58c80134" }, "id": { "type": "string", "description": "The id for Email Reference \nExample(s): Email_ID=Sample_Value" }, "Email_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_homeWebAddresses": { "type": "string", "pattern": "^(Web_Address_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Web_Address_ID", "example": "Web_Address_ID=21002" }, "ResourceIdPathValue_homeWebAddresses": {}, "usage_ab827579ee171000225b0b528418019f": { "allOf": [ { "$ref": "#/definitions/contactUsage_ab827579ee171000211397a6dede017d" }, {} ], "description": "The web address." }, "webAddress_33e26848dc0010003893a0202ced0165": { "allOf": [ { "type": "object", "properties": { "url": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The complete URL address for the web address.", "x-workday-type": "Text" }, "usage": { "$ref": "#/definitions/usage_ab827579ee171000225b0b528418019f" }, "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 comment associated with the web address.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "The id for Web Address Reference \nExample(s): Web_Address_ID=Sample_Value" }, "Web_Address_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_workInstantMessengers": { "type": "string", "pattern": "^(Instant_Messenger_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "example": "Instant_Messenger_ID=21002" }, "ResourceIdPathValue_workInstantMessengers": {}, "usage_ab827579ee1710002266db48222201a4": { "allOf": [ { "$ref": "#/definitions/contactUsage_ab827579ee171000211397a6dede017d" }, {} ], "description": "The instant messenger account." }, "type_33e26848dc00100037bb584480fe014a": { "allOf": [ { "$ref": "#/definitions/instantMessengerType_ab827579ee17100023fd6abda45c01b9" }, {} ], "description": "The instant messenger account type.", "x-workday-populated-by": { "path": "/values/instantMessenger/instantMessengerTypes", "field": "id" } }, "instantMessengerAccount_33e26848dc00100036f723337ebb0132": { "allOf": [ { "type": "object", "properties": { "usage": { "$ref": "#/definitions/usage_ab827579ee1710002266db48222201a4" }, "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 comment associated with the instant messenger account.", "x-workday-type": "Text" }, "type": { "$ref": "#/definitions/type_33e26848dc00100037bb584480fe014a" }, "userName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The instant messenger account username.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "The id for Instant Messenger Reference \nExample(s): Instant_Messenger_ID=Sample_Value" }, "Instant_Messenger_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_preferredName": { "type": "string", "pattern": "^(Excludable_Name)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Excludable_Name", "example": "Excludable_Name=21002" }, "ResourceIdPathValue_preferredName": {}, "ResourceIdPathValue_audioNamePronunciation": {}, "mediaDownload_5d5f0fb1184b10000b16f0e5c20f0000": { "allOf": [ { "type": "object", "properties": { "media_id": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Media ID", "x-workday-type": "Text" }, "download_audio": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Download Link", "x-workday-type": "Text" }, "filename": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Filename", "x-workday-type": "Text" }, "person_id": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Person ID", "x-workday-type": "Text" } } } ] }, "WorkdayReferenceId_photos": { "type": "string", "pattern": "^(Image_ID|File_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Image_ID, File_ID", "example": "Image_ID=21002" }, "ResourceIdPathValue_photos": {}, "WorkdayReferenceId_workEmails": { "type": "string", "pattern": "^(Email_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Email_ID", "example": "Email_ID=21002" }, "ResourceIdPathValue_workEmails": {}, "WorkdayReferenceId_homeAddresses": { "type": "string", "pattern": "^(Address_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Address_ID", "example": "Address_ID=21002" }, "ResourceIdPathValue_homeAddresses": {}, "WorkdayReferenceId_homePhones": { "type": "string", "pattern": "^(Phone_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Phone_ID", "example": "Phone_ID=21002" }, "ResourceIdPathValue_homePhones": {}, "deviceType_a58f621b14ee100018ac4d72f02901ea": { "allOf": [ { "$ref": "#/definitions/phoneDeviceType_33e26848dc00100062db00beab0c0205" }, {} ], "description": "The phone device type." }, "countryPhoneCode_a58f621b14ee1000185bf335b38401cb": { "allOf": [ { "$ref": "#/definitions/countryPhoneCode_ab827579ee1710001caa7c12047d0152" }, {} ], "description": "The country phone code for the phone number." }, "usage_df014bc8b5fa10000b2c21c8738d00e7": { "allOf": [ { "$ref": "#/definitions/contactUsage_ab827579ee171000211397a6dede017d" }, {} ], "description": "The current phone for the reference." }, "phoneReference_df014bc8b5fa10000af0fe7cb0ab00dd": { "allOf": [ { "type": "object", "properties": { "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 extension.", "x-workday-type": "Text" }, "deviceType": { "$ref": "#/definitions/deviceType_a58f621b14ee100018ac4d72f02901ea" }, "countryPhoneCode": { "$ref": "#/definitions/countryPhoneCode_a58f621b14ee1000185bf335b38401cb" }, "usage": { "$ref": "#/definitions/usage_df014bc8b5fa10000b2c21c8738d00e7" }, "completePhoneNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The complete phone number.", "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 Phone Reference \nExample(s): Phone_ID=Sample_Value" }, "Phone_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_additionalNames": { "type": "string", "pattern": "^(Excludable_Name)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Excludable_Name", "example": "Excludable_Name=21002" }, "ResourceIdPathValue_additionalNames": {}, "WorkdayReferenceId_workPhones": { "type": "string", "pattern": "^(Phone_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Phone_ID", "example": "Phone_ID=21002" }, "ResourceIdPathValue_workPhones": {}, "ResourceIdPathValue_personalInformation": {}, "maritalStatus_6de928ab1284100059f67714875a01f8": { "allOf": [ { "$ref": "#/definitions/maritalStatusInformation_6de928ab1284100059f5dc52629b01f4" }, {} ], "description": "The current person if Marital Status is enabled.", "x-conditionally-hidden": true }, "medicalExam_2b5dded3d48e10001612959d7eb30169": { "allOf": [ { "$ref": "#/definitions/medicalExam_2b5dded3d48e100016120452b8710164" }, {} ], "description": "The current person if Medical Exams is enabled.", "x-conditionally-hidden": true }, "uniformServiceReserveStatus_9503dc49ae9610001e48857455610000": { "allOf": [ { "$ref": "#/definitions/uniformServiceReserveStatus_b26f12db214d10000bf4b358ee390000" }, {} ], "description": "The Uniform Service Reserve Status of a person.", "x-conditionally-hidden": true }, "activeMilitaryUniformedService_9503dc49ae9610001fa8f76ed67d0000": { "allOf": [ { "$ref": "#/definitions/commonBooleanRepresentation_c6cfba790def100010efb5c8ebf00000" }, {} ], "description": "The Active Military Uniformed Service of a person.", "x-conditionally-hidden": true }, "politicalAffiliation_bf9cd1638e0f10000a6604bfef01014a": { "allOf": [ { "$ref": "#/definitions/politicalAffiliation_6de928ab128410005b04f3329eee0214" }, {} ], "description": "The Political Affliation for a person.", "x-conditionally-hidden": true }, "aboriginalIndigenousIdentification_37580627f49d1000258f815dc9c00001": { "allOf": [ { "$ref": "#/definitions/aboriginalIndigenousIdentification_37580627f49d10002587d93d0a820000" }, {} ], "description": "Returns the \\~aboriginal/indigenous identification\\~ for a person.", "x-conditionally-hidden": true }, "socialBenefitsLocality_80df32d43a5810000ce182cac97500bf": { "allOf": [ { "$ref": "#/definitions/socialBenefitsLocality_80df32d43a5810000ce11ade29d300bc" }, {} ], "description": "The Social Benefits Locality for a person.", "x-conditionally-hidden": true }, "primaryNationality_2b5dded3d48e100013b87a5e15b3012a": { "allOf": [ { "$ref": "#/definitions/countryAndNationality_06544db2578d10000ec1cd4257350000" }, {} ], "description": "The country of nationality for a person.", "x-conditionally-hidden": true }, "veteransPreferenceForRIF_a04210f7e84510001fb2873228810000": { "allOf": [ { "$ref": "#/definitions/commonBooleanRepresentation_c6cfba790def100010efb5c8ebf00000" }, {} ], "description": "Contains the veteran's preference for reduction in force actions for a person.", "x-conditionally-hidden": true }, "gender_414c4cee7d91100023fe32ce16e70019": { "allOf": [ { "$ref": "#/definitions/gender_6de928ab12841000544f9cd350c201b9" }, {} ], "description": "The gender for a person (female, male, not declared).", "x-conditionally-hidden": true }, "selectiveServiceRegistration_ca34e5d6a47710000f902f4d90240000": { "allOf": [ { "$ref": "#/definitions/commonBooleanRepresentation_c6cfba790def100010efb5c8ebf00000" }, {} ], "description": "Contains the selective service registration status for a person.", "x-conditionally-hidden": true }, "placeOfBirth_6de928ab1284100054a0b7e99c2b01c5": { "allOf": [ { "$ref": "#/definitions/placeOfBirth_6de928ab12841000549fe623b1ab01c0" }, {} ], "description": "The current person if Place of Birth is enabled.", "x-conditionally-hidden": true }, "ethnicitiesForVisualSurvey_2b5dded3d48e10001154aae4890a0104": { "allOf": [ { "$ref": "#/definitions/ethnicitiesForVisualSurvey_ebff7995b021100014bbd5c6cff700ae" }, {} ], "description": "The current person if Ethnicity for Visual Survey is enabled.", "x-conditionally-hidden": true }, "bloodType_a63806bf8576100013fa9dcbb7dc0111": { "allOf": [ { "$ref": "#/definitions/bloodType_6de928ab1284100056beb6e9884101cd" }, {} ], "description": "The blood type for a person.", "x-conditionally-hidden": true }, "personalInformation_414c4cee7d91100023fe329d6f900018": { "allOf": [ { "type": "object", "properties": { "genderIdentities": { "type": "array", "description": "The \\~gender identity\\~ values for the person.", "items": { "$ref": "#/definitions/genderIdentities_01524c5220b31000170c65d837010000" }, "x-workday-type": "Multi-instance", "x-label": "~Gender Identities~", "x-conditionally-hidden": true }, "militaryServices": { "type": "array", "description": "The Military Service for a person.", "items": { "$ref": "#/definitions/militaryService_6de928ab128410005b41e47e6d890218" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "pronouns": { "type": "array", "description": "The \\~pronoun\\~ values for the person.", "items": { "$ref": "#/definitions/pronouns_01524c5220b31000166e3ee623590000" }, "x-workday-type": "Multi-instance", "x-label": "~Pronouns~", "x-conditionally-hidden": true }, "sexualOrientations": { "type": "array", "description": "The \\~sexual orientation\\~ values for the person.", "items": { "$ref": "#/definitions/sexualOrientations_01524c5220b31000176c4bc48f510000" }, "x-workday-type": "Multi-instance", "x-label": "~Sexual Orientations~", "x-conditionally-hidden": true }, "additionalNationalities": { "type": "array", "description": "The countries of additional nationality for a person.", "items": { "$ref": "#/definitions/additionalNationalities_2b5dded3d48e100013ddc22953ee013a" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "maritalStatus": { "$ref": "#/definitions/maritalStatus_6de928ab1284100059f67714875a01f8" }, "medicalExam": { "$ref": "#/definitions/medicalExam_2b5dded3d48e10001612959d7eb30169" }, "relativeNames": { "type": "array", "description": "The relative names for a person.", "items": { "$ref": "#/definitions/relativeNames_e08d883b5eae10000403d79fe6d202e3" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "uniformServiceReserveStatus": { "$ref": "#/definitions/uniformServiceReserveStatus_9503dc49ae9610001e48857455610000" }, "activeMilitaryUniformedService": { "$ref": "#/definitions/activeMilitaryUniformedService_9503dc49ae9610001fa8f76ed67d0000" }, "disabledVeteranLeaveDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The Veteran's Preference Effective Date", "x-workday-type": "Date", "x-conditionally-hidden": true }, "hispanicOrLatino": { "type": "boolean", "example": true, "description": "True if the person has indicated they are Hispanic or Latino.", "x-workday-type": "Boolean", "x-conditionally-hidden": true }, "politicalAffiliation": { "$ref": "#/definitions/politicalAffiliation_bf9cd1638e0f10000a6604bfef01014a" }, "dateOfDeath": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date of death for a person.", "x-workday-type": "Date", "x-conditionally-hidden": true }, "disabilityStatuses": { "type": "array", "description": "The Disability Statuses for a person.", "items": { "$ref": "#/definitions/disabilityStatus_6de928ab128410005c56a5a5299c0239" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "religion": { "type": "array", "description": "The Religion for a person.", "items": { "$ref": "#/definitions/religion_6de928ab128410005a7df872e147020e" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "aboriginalIndigenousIdentification": { "$ref": "#/definitions/aboriginalIndigenousIdentification_37580627f49d1000258f815dc9c00001" }, "aboriginalIndigenousIdentificationDetails": { "type": "array", "description": "Returns the \\~aboriginal/indigenous identification\\~ details for a person.", "items": { "$ref": "#/definitions/aboriginalIndigenousDetails_37580627f49d1000257d05e999ea0000" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "socialBenefitsLocality": { "$ref": "#/definitions/socialBenefitsLocality_80df32d43a5810000ce182cac97500bf" }, "primaryNationality": { "$ref": "#/definitions/primaryNationality_2b5dded3d48e100013b87a5e15b3012a" }, "veteransPreferenceForRIF": { "$ref": "#/definitions/veteransPreferenceForRIF_a04210f7e84510001fb2873228810000" }, "gender": { "$ref": "#/definitions/gender_414c4cee7d91100023fe32ce16e70019" }, "selectiveServiceRegistration": { "$ref": "#/definitions/selectiveServiceRegistration_ca34e5d6a47710000f902f4d90240000" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date of birth for a person.", "x-workday-type": "Date", "x-conditionally-hidden": true }, "veteransPreference": { "type": "array", "description": "Contains the veteran's preference for a person.", "items": { "$ref": "#/definitions/veteransPreference_349dc615e38410001acc1309d9850000" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "sexualOrientationAndGenderIdentity": { "type": "array", "description": "The Sexual Orientation & Gender Identity for a person.", "items": { "$ref": "#/definitions/lgbtIdentification_6de928ab128410005a65d120bc8c020a" }, "x-workday-type": "Multi-instance", "x-label": "~Sexual Orientation~ & ~Gender Identity~", "x-conditionally-hidden": true }, "placeOfBirth": { "$ref": "#/definitions/placeOfBirth_6de928ab1284100054a0b7e99c2b01c5" }, "ethnicities": { "type": "array", "description": "The Ethnicity for a person.", "items": { "$ref": "#/definitions/ethnicity_6de928ab1284100058892e53dac501d1" }, "x-workday-type": "Multi-instance", "x-conditionally-hidden": true }, "ethnicitiesForVisualSurvey": { "$ref": "#/definitions/ethnicitiesForVisualSurvey_2b5dded3d48e10001154aae4890a0104" }, "citizenshipStatuses": { "type": "array", "description": "The Citizenship Statuses for a person.", "items": { "$ref": "#/definitions/citizenshipStatus_80df32d43a5810000f452a84da970114" }, "x-workday-type": "Multi-instance", "x-label": "Citizenship Status", "x-conditionally-hidden": true }, "bloodType": { "$ref": "#/definitions/bloodType_a63806bf8576100013fa9dcbb7dc0111" } } } ] }, "WorkdayReferenceId_workWebAddresses": { "type": "string", "pattern": "^(Web_Address_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Web_Address_ID", "example": "Web_Address_ID=21002" }, "ResourceIdPathValue_workWebAddresses": {}, "WorkdayReferenceId_homeInstantMessengers": { "type": "string", "pattern": "^(Instant_Messenger_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Instant_Messenger_ID", "example": "Instant_Messenger_ID=21002" }, "ResourceIdPathValue_homeInstantMessengers": {}, "ResourceIdPathValue_workContactInformationChanges": {}, "alternateWorkLocation_bdfa2c83ea5e10002b70a80a153e5d68": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The address reference instance from the Alternate Work Location (Primary Work Address) that links to the Work Contact Change event." }, "businessProcessParameters_bdfa2c83ea5e10002b873037350f5d6c": { "allOf": [ { "$ref": "#/definitions/businessProcessParameters_83f6f6b7c38d100009c69131dea04a14" }, {} ], "description": "The Action Event instance to be used with businessProcessLinkable linked service representations." }, "workContactChangeEventView_bdfa2c83ea5e10002b70a7e9f69e5d67": { "allOf": [ { "type": "object", "properties": { "alternateWorkLocation": { "$ref": "#/definitions/alternateWorkLocation_bdfa2c83ea5e10002b70a80a153e5d68" }, "businessProcessParameters": { "$ref": "#/definitions/businessProcessParameters_bdfa2c83ea5e10002b873037350f5d6c" }, "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." } } } ] }, "alternateWorkLocation_d72a8353f91e1000169a83b894e7046e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The address reference instance from the Alternate Work Location (Primary Work Address) that links to the Work Contact Change event." }, "workContactChangeEvent_d72a8353f91e1000169a839c31a0046d": { "allOf": [ { "type": "object", "properties": { "alternateWorkLocation": { "$ref": "#/definitions/alternateWorkLocation_d72a8353f91e1000169a83b894e7046e" }, "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." } } } ] }, "country_c1bb9f46f65210002d2fa329fe6700b4": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "\\~Country\\~" }, "countryRegion_c1bb9f46f65210002d2fa322479a00b2": { "allOf": [ { "$ref": "#/definitions/region_ab827579ee1710001f7eb5159a9b0170" }, {} ], "description": "Country Region" }, "usage_c1bb9f46f65210002d2fa2e7babe00a8": { "allOf": [ { "$ref": "#/definitions/workContactUsage_81f66ab16f7510005c60769e6db24871" }, {} ], "description": "Address Instance Referenced" }, "countryCity_c1bb9f46f65210002d2fa2bb24a300a1": { "allOf": [ { "$ref": "#/definitions/city_ab827579ee1710002095f51c0e3f0178" }, {} ], "description": "\\~Country\\~ City" }, "workAddressReference_c1bb9f46f65210002d2fa259a1c10095": { "allOf": [ { "type": "object", "properties": { "addressLine3": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 3", "x-workday-type": "Text" }, "addressLine8Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 8", "x-workday-type": "Text" }, "regionSubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 2", "x-workday-type": "Text" }, "cityLocal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City - Local", "x-workday-type": "Text" }, "citySubdivision1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 1 - Local", "x-workday-type": "Text" }, "addressLine6Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 6", "x-workday-type": "Text" }, "addressLine4Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 4", "x-workday-type": "Text" }, "regionSubdivision1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 1 - Local", "x-workday-type": "Text" }, "country": { "$ref": "#/definitions/country_c1bb9f46f65210002d2fa329fe6700b4" }, "addressLine9": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 9", "x-workday-type": "Text" }, "addressLine4": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 4", "x-workday-type": "Text" }, "citySubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 1", "x-workday-type": "Text" }, "addressLine8": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 8", "x-workday-type": "Text" }, "addressLine5Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 5", "x-workday-type": "Text" }, "addressLine1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 1", "x-workday-type": "Text" }, "addressLine6": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 6", "x-workday-type": "Text" }, "city": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City", "x-workday-type": "Text" }, "addressLine3Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 3", "x-workday-type": "Text" }, "postalCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Postal Code", "x-workday-type": "Text" }, "addressLine9Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 9", "x-workday-type": "Text" }, "addressLine2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 2", "x-workday-type": "Text" }, "addressLine1Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 1", "x-workday-type": "Text" }, "addressLine7Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 7", "x-workday-type": "Text" }, "countryRegion": { "$ref": "#/definitions/countryRegion_c1bb9f46f65210002d2fa322479a00b2" }, "addressLine5": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 5", "x-workday-type": "Text" }, "usage": { "$ref": "#/definitions/usage_c1bb9f46f65210002d2fa2e7babe00a8" }, "regionSubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Region Subdivision 1", "x-workday-type": "Text" }, "addressLine7": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Address Line 7", "x-workday-type": "Text" }, "effective": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date this business process takes effect.", "readOnly": true, "x-workday-type": "Date" }, "citySubdivision2Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 2 - Local", "x-workday-type": "Text" }, "addressLine2Local": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Local Address Line 2", "x-workday-type": "Text" }, "countryCity": { "$ref": "#/definitions/countryCity_c1bb9f46f65210002d2fa2bb24a300a1" }, "citySubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "City Subdivision 2", "x-workday-type": "Text" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Address_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "deviceType_db1991f2fb091000169c5e28fc0400bb": { "allOf": [ { "$ref": "#/definitions/phoneDeviceType_33e26848dc00100062db00beab0c0205" }, {} ], "description": "The phone device type." }, "countryPhoneCode_db1991f2fb091000169c5e0cb7c200b9": { "allOf": [ { "$ref": "#/definitions/countryPhoneCode_ab827579ee1710001caa7c12047d0152" }, {} ], "description": "The phone code for a country." }, "phoneNumberValidation_db1991f2fb091000169c5dfa023800b8": { "allOf": [ { "type": "object", "properties": { "completePhoneNumber": { "type": "string", "example": "+19259519000", "description": "The complete phone number.", "x-workday-type": "Text" }, "deviceType": { "$ref": "#/definitions/deviceType_db1991f2fb091000169c5e28fc0400bb" }, "countryPhoneCode": { "$ref": "#/definitions/countryPhoneCode_db1991f2fb091000169c5e0cb7c200b9" } } } ] }, "WorkdayReferenceId_countries": { "type": "string", "pattern": "^(ISO_3166-1_Alpha-3_Code|ISO_3166-1_Numeric-3_Code|ISO_3166-1_Alpha-2_Code|OPM_Country_Code)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-1_Alpha-2_Code, OPM_Country_Code", "example": "ISO_3166-1_Alpha-3_Code=21002" }, "ResourceIdPathValue_countries": {}, "personCountryViewDefinition_f206795ea40e1000040cc6f5da4f002a": { "allOf": [ { "type": "object", "properties": { "enabledForAddressLookup": { "type": "boolean", "example": true, "description": "True if the country is enabled for Address Lookup.", "x-workday-type": "Boolean" }, "alpha2Code": { "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-2 code for a country.", "maxLength": 2, "x-workday-type": "Text" }, "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" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "componentType_98e46a86842a10000dc278233c7e0280": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The name of the Workday (person) name component. This is the name of the generic, non-country-specific name component, not the country-specific label override for the component in a given country." }, "personLocalizedAddressComponentFormat_98e46a86842a10000dc277ddefc7027b": { "allOf": [ { "type": "object", "properties": { "label": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Country-specific label override for an address component. If no country-specific override exists, the generic component name is used. For example, for the US, the label State overrides the underlying generic component name Region.", "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 in which the address component appears on the address maintenance page. The order of an address component is country-specific.", "x-workday-type": "Text" }, "webServiceAlias": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The custom Web Service Alias defined on an address component. For use with the Recruiting API.", "x-workday-type": "Text" }, "componentType": { "$ref": "#/definitions/componentType_98e46a86842a10000dc278233c7e0280" }, "required": { "type": "boolean", "example": true, "description": "True if the address component is required for the country.", "x-workday-type": "Boolean" }, "type": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "x-workday-type": "Text" } } } ] }, "componentType_eae9f0331ab51000162aafecb6bf00eb": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The name of the Workday name component. This is the name of the generic, non-country-specific name component, not the country-specific label override for the component in a given country." }, "personLocalizedNameComponentFormat_51f9e585eec710001050c68b768b00ea": { "allOf": [ { "type": "object", "properties": { "componentType": { "$ref": "#/definitions/componentType_eae9f0331ab51000162aafecb6bf00eb" }, "type": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "x-workday-type": "Text" }, "webServiceAlias": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The custom Web Service Alias defined on a name component. For use with the Recruiting API.", "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 assigned to the name component on the Maintain Name Components by Country task. The order of a name component is specific to a country.", "x-workday-type": "Text" }, "showDisplayOnlyOnPreferred": { "type": "boolean", "example": true, "description": "True if the name component is display only on preferred. This field is for China only.", "x-workday-type": "Boolean" }, "label": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The country-specific label override for a name component. If no country-specific override exists, the generic name component name is used. For example, for Russia, the label Patronymic Name overrides the underlying generic component name Secondary.", "x-workday-type": "Text" }, "required": { "type": "boolean", "example": true, "description": "True if the name component is required for the country.", "x-workday-type": "Boolean" } } } ] }, "metadataType_e77ea44df9be1000184c7fce7a0d0001": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The Metadata type for the given Phone Device Type." }, "phoneDeviceTypeDefinition_e77ea44df9be10001757721fb1d70000": { "allOf": [ { "type": "object", "properties": { "metadataType": { "$ref": "#/definitions/metadataType_e77ea44df9be1000184c7fce7a0d0001" }, "hiddenForRecruiting": { "type": "boolean", "example": true, "description": "Returns if Phone Device Type is hidden for Recruiting.", "x-workday-type": "Boolean" }, "default": { "type": "boolean", "example": true, "description": "Returns if Phone Device Type is default", "x-workday-type": "Boolean" }, "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." } } } ] }, "phoneDeviceTypes_e77ea44df9be100016b9510a45100000": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/phoneDeviceTypeDefinition_e77ea44df9be10001757721fb1d70000" } } } }, "country_ab827579ee1710001caa7c36228c0153": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "The country name for a country phone code." }, "countryPhoneCode_ab827579ee1710001caa7c12047d0152": { "allOf": [ { "type": "object", "properties": { "country": { "$ref": "#/definitions/country_ab827579ee1710001caa7c36228c0153" }, "countryPhoneCode": { "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 code for a country.", "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 \\~Country\\~ Phone Code \nExample(s): Country_Phone_Code_ID=Sample_Value" }, "Country_Phone_Code_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "countryPhoneCodes_7d0f2c61404910000d78252c4e6d0000": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/countryPhoneCode_ab827579ee1710001caa7c12047d0152" } } } }, "uploadedBy_b32ff437243510000e22e06470370160": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Returns the primary Role of the person who uploaded the Attachment.", "x-readOnly": true }, "category_43b30ba735b8100011ee4781a9d50146": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Returns the category of a Business Process Attachment." }, "contentType_43b30ba735b8100011ee47993f11014a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Content type of the attachment" }, "eventAttachmentsForToolbar_43b30ba735b8100011ee4767246d0143": { "allOf": [ { "type": "object", "properties": { "uploadDate": { "type": "string", "format": "date-time", "example": "2026-11-02T08:00:00.000Z", "description": "Returns Date the Business Process Attachment was updated.", "readOnly": true, "x-workday-type": "Date" }, "fileLength": { "type": "integer", "example": "99999999999", "description": "File length of the attachment", "x-workday-type": "Numeric" }, "fileName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "File name of the attachment", "maxLength": 255, "x-workday-type": "Text" }, "uploadedBy": { "$ref": "#/definitions/uploadedBy_b32ff437243510000e22e06470370160" }, "category": { "$ref": "#/definitions/category_43b30ba735b8100011ee4781a9d50146" }, "description": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Event attachment description", "x-workday-type": "Text" }, "file": { "type": "string", "format": "binary", "description": "For RaaS Only (Reports used as Web Services). Returns the raw Base64 data for an attachment or image.", "x-workday-type": "File" }, "contentType": { "$ref": "#/definitions/contentType_43b30ba735b8100011ee47993f11014a" }, "id": { "type": "string", "description": "The id for Event Attachment (Derived) \nExample(s): File_ID=Sample_Value" }, "File_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "person_86093b8a932f10001499f38c72410130": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Comment made by Person" }, "comments_86093b8a932f10001499f356ff83012e": { "allOf": [ { "type": "object", "properties": { "person": { "$ref": "#/definitions/person_86093b8a932f10001499f38c72410130" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Comment", "x-workday-type": "Text" }, "commentDate": { "type": "string", "format": "date-time", "example": "2026-11-02T08:00:00.000Z", "description": "Gives the moment at which the instance was originally created.", "x-workday-type": "Date" } } } ] }, "attachments_43b30ba735b8100010e21c8b136f0119": { "allOf": [ { "$ref": "#/definitions/eventAttachmentsForToolbar_43b30ba735b8100011ee4767246d0143" }, { "properties": { "id": { "type": "string", "description": "The id for Event Attachment (Derived) \nExample(s): File_ID=Sample_Value" } } } ] }, "for_5d688bd57bb910001815ab3dd10024a9": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The thing which this business process is about. It could be another business process if this is a sub-process", "x-readOnly": true }, "action_38ff08ab6736100010816009079d0126": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "a set containing no instances" }, "overallBusinessProcess_5d688bd57bb910001815ab49927724aa": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Returns the Top Level (overall) Business Process that this Event is part of or returns the same instance if this Event is not a sub-process.", "x-readOnly": true }, "transactionStatus_7457adcbe0fa1000089b63ab3a510000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Transaction Status for Facet Search" }, "businessProcessParameters_83f6f6b7c38d100009c69131dea04a14": { "allOf": [ { "type": "object", "required": [ "action" ], "properties": { "warningValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Warning message for an action event triggered by a condition.", "readOnly": true, "x-workday-type": "Text" }, "attachments": { "type": "array", "description": "Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met.", "items": { "$ref": "#/definitions/attachments_43b30ba735b8100010e21c8b136f0119" }, "x-workday-type": "Multi-instance" }, "overallStatus": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The current status of the business process. For example: Successfully Completed, Denied, Terminated.", "readOnly": true, "x-workday-type": "Text" }, "for": { "$ref": "#/definitions/for_5d688bd57bb910001815ab3dd10024a9" }, "criticalValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Validation message for an action event triggered by a condition.", "readOnly": true, "x-workday-type": "Text" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Returns a null.", "x-workday-type": "Text" }, "action": { "$ref": "#/definitions/action_38ff08ab6736100010816009079d0126" }, "overallBusinessProcess": { "$ref": "#/definitions/overallBusinessProcess_5d688bd57bb910001815ab49927724aa" }, "comments": { "type": "array", "description": "Returns the comments for the current business process.", "readOnly": true, "items": { "$ref": "#/definitions/comments_86093b8a932f10001499f356ff83012e" }, "x-workday-type": "Multi-instance" }, "transactionStatus": { "$ref": "#/definitions/transactionStatus_7457adcbe0fa1000089b63ab3a510000" } } } ] }, "instantMessengerType_e3f4243ada0b10000d441b1688d20087": { "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 Instant Messenger Type \nExample(s): Instant_Messenger_Type_ID=Sample_Value" }, "Instant_Messenger_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "usageType_6a6eaf50b6ad100012e8021249e601fc": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Communication Usage Type \nExample(s): Communication_Usage_Type_ID=Sample_Value" }, "Communication_Usage_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "usageBehavior_1089da0ab90910000fa6c19789ce0896": { "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 Usage Type \nExample(s): Communication_Usage_Behavior_ID=Sample_Value, Communication_Usage_Behavior_Tenanted_ID=Sample_Value" }, "Communication_Usage_Behavior_ID": { "type": "string", "description": "Reference id of the instance" }, "Communication_Usage_Behavior_Tenanted_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "usageType_51665e7371e310000f554a00d31000f2": { "allOf": [ { "$ref": "#/definitions/usageType_6a6eaf50b6ad100012e8021249e601fc" }, {} ], "description": "The usage type for the communication method, such as home or work." }, "usedFor_1089da0ab90910000fa7749a454b089b": { "allOf": [ { "$ref": "#/definitions/usageBehavior_1089da0ab90910000fa6c19789ce0896" }, { "properties": { "id": { "type": "string", "description": "The id for Usage Type \nExample(s): Communication_Usage_Behavior_ID=Sample_Value, Communication_Usage_Behavior_Tenanted_ID=Sample_Value" } } } ] }, "contactUsage_1089da0ab90910000fa7748617db0898": { "allOf": [ { "type": "object", "properties": { "usageType": { "$ref": "#/definitions/usageType_51665e7371e310000f554a00d31000f2" }, "usedFor": { "type": "array", "description": "Usage behaviors for the communication method, such as mailing, billing shipping etc.", "items": { "$ref": "#/definitions/usedFor_1089da0ab90910000fa7749a454b089b" }, "x-workday-type": "Multi-instance" }, "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 description for a given communication method.", "x-workday-type": "Text" }, "primary": { "type": "boolean", "example": true, "description": "True if the communication method has any primary usage type.", "x-workday-type": "Boolean" }, "public": { "type": "boolean", "example": true, "description": "True if the communication method is public. If no results are returned, the communication method is private.", "x-workday-type": "Boolean" } } } ] }, "country_1089da0ab90910000f6e4df524710885": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The country name for a country phone code." }, "countryPhoneCode_1089da0ab90910000f6e4de36f670883": { "allOf": [ { "type": "object", "properties": { "country": { "$ref": "#/definitions/country_1089da0ab90910000f6e4df524710885" }, "countryPhoneCode": { "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 code for a country.", "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 \\~Country\\~ Phone Code \nExample(s): Country_Phone_Code_ID=Sample_Value" }, "Country_Phone_Code_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "phoneDeviceType_1089da0ab90910000f85ace9e4050892": { "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 Phone Type \nExample(s): Phone_Device_Type_ID=Sample_Value" }, "Phone_Device_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "city_ab827579ee1710002095f51c0e3f0178": { "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\\~ City \nExample(s): Country_Subregion_Internal_ID=Sample_Value, Country_Subregion_Code_In_Country=Sample_Value" }, "Country_Subregion_Internal_ID": { "type": "string", "description": "Reference id of the instance" }, "Country_Subregion_Code_In_Country": { "type": "string", "description": "Reference id of the instance" } } } ] }, "country_8beeb162738910001433a1ef009a01d0": { "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, ISO_3166-1_Numeric-3_Code=Sample_Value, ISO_3166-1_Alpha-2_Code=Sample_Value" }, "ISO_3166-1_Alpha-3_Code": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-1_Numeric-3_Code": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-1_Alpha-2_Code": { "type": "string", "description": "Reference id of the instance" } } } ] }, "region_ab827579ee1710001f7eb5159a9b0170": { "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 Region \nExample(s): Country_Region_ID=Sample_Value, ISO_3166-2_Code=Sample_Value" }, "Country_Region_ID": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-2_Code": { "type": "string", "description": "Reference id of the instance" } } } ] }, "usageBehavior_33e26848dc0010003a3c3827858901b4": { "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 Communication Usage Behavior Mixed (Derived) \nExample(s): Communication_Usage_Behavior_ID=Sample_Value, Communication_Usage_Behavior_Tenanted_ID=Sample_Value" }, "Communication_Usage_Behavior_ID": { "type": "string", "description": "Reference id of the instance" }, "Communication_Usage_Behavior_Tenanted_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "usageType_901718dd5e7910000cc03935c73e029c": { "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 Communication Usage Type" } } } ] }, "usedFor_c1bb9f46f65210002d3c343a3e1d00bb": { "allOf": [ { "$ref": "#/definitions/usageBehavior_33e26848dc0010003a3c3827858901b4" }, { "properties": { "id": { "type": "string", "description": "The id for Communication Usage Behavior Mixed (Derived) \nExample(s): Communication_Usage_Behavior_ID=Sample_Value, Communication_Usage_Behavior_Tenanted_ID=Sample_Value" } } } ] }, "usageType_c1bb9f46f65210002d3c343d773200bc": { "allOf": [ { "$ref": "#/definitions/usageType_901718dd5e7910000cc03935c73e029c" }, {} ], "description": "Returns the usage type for a given communication method." }, "homeContactUsage_c1bb9f46f65210002d3c341a5dc400b8": { "allOf": [ { "type": "object", "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": "Returns the description for a given communication method.", "x-workday-type": "Text" }, "public": { "type": "boolean", "example": true, "description": "Is Public Visibility", "x-workday-type": "Boolean" }, "primary": { "type": "boolean", "example": true, "description": "Is Primary", "x-workday-type": "Boolean" }, "usedFor": { "type": "array", "description": "Used For", "items": { "$ref": "#/definitions/usedFor_c1bb9f46f65210002d3c343a3e1d00bb" }, "x-workday-type": "Multi-instance" }, "usageType": { "$ref": "#/definitions/usageType_c1bb9f46f65210002d3c343d773200bc" } } } ] }, "universalID_814af6e5b9fa100022bff92eb5140117": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Universal Identifier \nExample(s): Universal_Identifier_ID=Sample_Value" }, "Universal_Identifier_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "universal_ID_e451ce2c8b48100007c31392a1ff00c2": { "allOf": [ { "$ref": "#/definitions/universalID_814af6e5b9fa100022bff92eb5140117" }, {} ], "description": "The universal ID for a person." }, "personRepresentation_e451ce2c8b48100007c312f3f72700b3": { "allOf": [ { "type": "object", "properties": { "photos": { "type": "string", "format": "url", "description": "The image for the person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "homeEmails": { "type": "string", "format": "url", "description": "The home email addresses for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "personalInformation": { "type": "string", "format": "url", "description": "The person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "homeWebAddresses": { "type": "string", "format": "url", "description": "The home web addresses for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "universal_ID": { "$ref": "#/definitions/universal_ID_e451ce2c8b48100007c31392a1ff00c2" }, "workInstantMessengers": { "type": "string", "format": "url", "description": "The work instant messenger accounts for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "homePhones": { "type": "string", "format": "url", "description": "The home phone numbers for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "preferredName": { "type": "string", "format": "url", "description": "The preferred name for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "workEmails": { "type": "string", "format": "url", "description": "The work email addresses for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "workAddresses": { "type": "string", "format": "url", "description": "The work addresses for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "workWebAddresses": { "type": "string", "format": "url", "description": "The work web addresses for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "homeAddresses": { "type": "string", "format": "url", "description": "The home addresses for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "audioNamePronunciation": { "type": "string", "format": "url", "description": "The Media related to Audio Name Pronunciation for a Person", "readOnly": true, "x-workday-type": "Multi-instance" }, "legalName": { "type": "string", "format": "url", "description": "The Legal Name for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "socialNetworks": { "type": "string", "format": "url", "description": "The social network accounts for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "workPhones": { "type": "string", "format": "url", "description": "The work phone numbers for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "additionalNames": { "type": "string", "format": "url", "description": "The additional names for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "homeInstantMessengers": { "type": "string", "format": "url", "description": "The home instant messenger accounts for a person.", "readOnly": true, "x-workday-type": "Multi-instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "usageType_901718dd5e7910000cb06dace3950299": { "allOf": [ { "$ref": "#/definitions/usageType_901718dd5e7910000cc03935c73e029c" }, {} ], "description": "The usage type for the communication method, such as home or work." }, "usedFor_ab827579ee171000211397c886a50180": { "allOf": [ { "$ref": "#/definitions/usageBehavior_33e26848dc0010003a3c3827858901b4" }, { "properties": { "id": { "type": "string", "description": "The id for Usage Type \nExample(s): Communication_Usage_Behavior_ID=Sample_Value, Communication_Usage_Behavior_Tenanted_ID=Sample_Value" } } } ] }, "contactUsage_ab827579ee171000211397a6dede017d": { "allOf": [ { "type": "object", "properties": { "usageType": { "$ref": "#/definitions/usageType_901718dd5e7910000cb06dace3950299" }, "usedFor": { "type": "array", "description": "Usage behaviors for the communication method, such as mailing, billing shipping etc.", "items": { "$ref": "#/definitions/usedFor_ab827579ee171000211397c886a50180" }, "x-workday-type": "Multi-instance" }, "public": { "type": "boolean", "example": true, "description": "True if the communication method is public. If no results are returned, the communication method is private.", "x-workday-type": "Boolean" }, "primary": { "type": "boolean", "example": true, "description": "True if the communication method has any primary usage type.", "x-workday-type": "Boolean" } } } ] }, "phoneDeviceType_33e26848dc00100062db00beab0c0205": { "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 Phone Type \nExample(s): Phone_Device_Type_ID=Sample_Value" }, "Phone_Device_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "instantMessengerType_ab827579ee17100023fd6abda45c01b9": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Instant_Messenger_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "webAddresses_d8f2aecf3d6310001bdd0d6312f202b8": { "allOf": [ { "$ref": "#/definitions/webAddress_33e26848dc0010003893a0202ced0165" }, { "properties": { "id": { "type": "string", "description": "The id for Web Address Reference \nExample(s): Web_Address_ID=Sample_Value" } } } ] }, "addresses_d8f2aecf3d63100018c36066efa602a4": { "allOf": [ { "$ref": "#/definitions/addressReference_9c3ab7b846e4100009e5ec55fa530024" }, { "properties": { "id": { "type": "string", "description": "The id for Address Reference \nExample(s): Address_ID=Sample_Value" } } } ] }, "emails_d8f2aecf3d63100017e85a350c0b025d": { "allOf": [ { "$ref": "#/definitions/emailReference_9c3ab7b846e41000327e788d9664012a" }, { "properties": { "id": { "type": "string", "description": "The id for Email Reference \nExample(s): Email_ID=Sample_Value" } } } ] }, "phoneNumbers_d8f2aecf3d631000181f8325be5d026e": { "allOf": [ { "$ref": "#/definitions/phoneReference_df014bc8b5fa10000af0fe7cb0ab00dd" }, { "properties": { "id": { "type": "string", "description": "The id for Phone Reference \nExample(s): Phone_ID=Sample_Value" } } } ] }, "instantMessengers_d8f2aecf3d6310001c2dce8a8c3302dc": { "allOf": [ { "$ref": "#/definitions/instantMessengerAccount_33e26848dc00100036f723337ebb0132" }, { "properties": { "id": { "type": "string", "description": "The id for Instant Messenger Reference \nExample(s): Instant_Messenger_ID=Sample_Value" } } } ] }, "countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Predefined_Name_Component_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "contentType_6b9baf67ce60100011fd138066140090": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Content type of the image attachment." }, "personPhoto_6b9baf67ce60100007d43c79e7a30011": { "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": "Filename of the image attachment.", "maxLength": 255, "x-workday-type": "Text" }, "contentType": { "$ref": "#/definitions/contentType_6b9baf67ce60100011fd138066140090" }, "width": { "type": "number", "example": 100000000000, "description": "Width of Cropped Image.", "x-workday-type": "Numeric" }, "file": { "type": "string", "format": "binary", "description": "For RaaS Only (Reports used as Web Services). The raw Base64 data for an attachment or image.", "x-workday-type": "File" }, "fileLength": { "type": "integer", "example": "99999999999", "description": "File length of the image attachment.", "x-workday-type": "Numeric" }, "height": { "type": "number", "example": 100000000000, "description": "Height of Cropped Image.", "x-workday-type": "Numeric" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Image_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "genderIdentities_01524c5220b31000170c65d837010000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Gender_Identity_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "militaryRank_6de928ab128410005be5dbfb939d0234": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Military_Rank_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "militaryServiceReference_aaeb64c958b2100016889fe0267e0246": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Military_Service_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "country_6de928ab128410005b9a894c5c67022a": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "The country for the Military Status." }, "militaryStatus_6de928ab128410005b9a8926efa80226": { "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": "The military status description.", "x-workday-type": "Text" }, "country": { "$ref": "#/definitions/country_6de928ab128410005b9a894c5c67022a" }, "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 \\~military status\\~ code.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Military_Status_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "militaryServiceType_6de928ab128410005bc12d1bc69b0230": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Military_Service_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "militaryDischargeType_b15af3935f8910001f7585a44c0b0000": { "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 \\~Military Discharge Type\\~" } } } ] }, "rank_6de928ab128410005b41e4ba56a6021f": { "allOf": [ { "$ref": "#/definitions/militaryRank_6de928ab128410005be5dbfb939d0234" }, {} ], "description": "The Military Rank for the Military Service." }, "militaryServiceReference_6de928ab128410005b41e4b2f27d021e": { "allOf": [ { "$ref": "#/definitions/militaryServiceReference_aaeb64c958b2100016889fe0267e0246" }, {} ], "description": "The reference id for the military service entry. This is the unique identifier for the military service that is assigned at creation and then maintained throughout its life as it is edited." }, "status_6de928ab128410005b41e4a4e4d2021c": { "allOf": [ { "$ref": "#/definitions/militaryStatus_6de928ab128410005b9a8926efa80226" }, {} ], "description": "The \\~Military Status\\~ for the Military Service." }, "type_6de928ab128410005b41e4ac0ec5021d": { "allOf": [ { "$ref": "#/definitions/militaryServiceType_6de928ab128410005bc12d1bc69b0230" }, {} ], "description": "Military Service Type for Military Service" }, "militaryDischargeTypeReference_b26f12db214d100010f22b23c4e70000": { "allOf": [ { "$ref": "#/definitions/militaryDischargeType_b15af3935f8910001f7585a44c0b0000" }, {} ], "description": "The Military Service.has Military Discharge Type reference." }, "militaryService_6de928ab128410005b41e47e6d890218": { "allOf": [ { "type": "object", "properties": { "rank": { "$ref": "#/definitions/rank_6de928ab128410005b41e4ba56a6021f" }, "militaryServiceReference": { "$ref": "#/definitions/militaryServiceReference_6de928ab128410005b41e4b2f27d021e" }, "status": { "$ref": "#/definitions/status_6de928ab128410005b41e4a4e4d2021c" }, "type": { "$ref": "#/definitions/type_6de928ab128410005b41e4ac0ec5021d" }, "begin": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The Military Status Begin Date for the Military Service.", "x-workday-type": "Date" }, "militaryDischargeTypeReference": { "$ref": "#/definitions/militaryDischargeTypeReference_b26f12db214d100010f22b23c4e70000" }, "notes": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Notes associated with the Military Service.", "x-workday-type": "Rich Text" }, "discharge": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The Discharge Date for the Military Service.", "x-workday-type": "Date" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "pronouns_01524c5220b31000166e3ee623590000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Pronoun_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "sexualOrientations_01524c5220b31000176c4bc48f510000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Sexual_Orientation_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "countryAndNationality_06544db2578d10000ec1cd4257350000": { "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 and Nationality \nExample(s): ISO_3166-1_Alpha-3_Code=Sample_Value, ISO_3166-1_Numeric-3_Code=Sample_Value, ISO_3166-1_Alpha-2_Code=Sample_Value, Non-Country_Nationality=Sample_Value" }, "ISO_3166-1_Alpha-3_Code": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-1_Numeric-3_Code": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-1_Alpha-2_Code": { "type": "string", "description": "Reference id of the instance" }, "Non-Country_Nationality": { "type": "string", "description": "Reference id of the instance" } } } ] }, "location_aaeb64c958b2100011f0c7fc94120224": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "ISO_3166-1_Alpha-3_Code": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-1_Numeric-3_Code": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-1_Alpha-2_Code": { "type": "string", "description": "Reference id of the instance" }, "Country_Region_ID": { "type": "string", "description": "Reference id of the instance" }, "Country_Subregion_Internal_ID": { "type": "string", "description": "Reference id of the instance" }, "Country_Subregion_Code_In_Country": { "type": "string", "description": "Reference id of the instance" }, "ISO_3166-2_Code": { "type": "string", "description": "Reference id of the instance" } } } ] }, "location_6de928ab1284100059cd755321a501f1": { "allOf": [ { "$ref": "#/definitions/location_aaeb64c958b2100011f0c7fc94120224" }, {} ], "description": "The Country or Country Region for a Marital Status." }, "maritalStatus_6de928ab1284100059b4fc2c983801e9": { "allOf": [ { "type": "object", "properties": { "location": { "$ref": "#/definitions/location_6de928ab1284100059cd755321a501f1" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Marital_Status_ID": { "type": "string", "description": "Reference id of the instance" }, "Marital_Status_Code": { "type": "string", "description": "Reference id of the instance" } } } ] }, "status_6de928ab1284100059f5dc66f77e01f6": { "allOf": [ { "$ref": "#/definitions/maritalStatus_6de928ab1284100059b4fc2c983801e9" }, {} ], "description": "The Marital Status for a person." }, "maritalStatusInformation_6de928ab1284100059f5dc52629b01f4": { "allOf": [ { "type": "object", "properties": { "date": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The Marital Status Date for a person.", "x-workday-type": "Date" }, "status": { "$ref": "#/definitions/status_6de928ab1284100059f5dc66f77e01f6" } } } ] }, "medicalExam_2b5dded3d48e100016120452b8710164": { "allOf": [ { "type": "object", "properties": { "lastExamDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date of the last medical exam for a person.", "x-workday-type": "Date" }, "notes": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Medical exam notes for a person.", "x-workday-type": "Text" }, "expirationDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "Medical exam expiration date for a person.", "x-workday-type": "Date" } } } ] }, "localName_ab5c028f50b310001cb4684782660256": { "allOf": [ { "type": "object", "properties": { "secondaryLast2": { "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 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" }, "last2": { "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" }, "first2": { "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" }, "middle2": { "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 second middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used.", "x-workday-type": "Text" }, "first": { "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" }, "last": { "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" }, "middle": { "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" }, "secondaryLast": { "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" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "relativeType_e08d883b5eae100003cff859e1ec02dd": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Relative_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "royalSuffix_e08d883b5eae10000403d7d259db02ed": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The royal suffix for a relative name." }, "religiousSuffix_e08d883b5eae10000403d7eb401e02f2": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The religious suffix for a relative name." }, "localPersonName_e08d883b5eae10000403d7cd713c02ec": { "allOf": [ { "$ref": "#/definitions/localName_ab5c028f50b310001cb4684782660256" }, {} ], "description": "The Local Person Name instance for a relative name." }, "honorarySuffix_e08d883b5eae10000403d7acba9602e5": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The honorary suffix for a relative name." }, "country_e08d883b5eae10000403d7c8e60502eb": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "The country from the relative name." }, "salutationSuffix_e08d883b5eae10000403d7d736c102ee": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The salutation from a relative name." }, "relativeType_e08d883b5eae1000040cc1231a5902f5": { "allOf": [ { "$ref": "#/definitions/relativeType_e08d883b5eae100003cff859e1ec02dd" }, {} ], "description": "The relative type for a relative name." }, "socialSuffix_e08d883b5eae10000403d7dc081502ef": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The social suffix for a relative name." }, "professionalSuffix_e08d883b5eae10000403d7e2171f02f0": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The professional suffix for a relative name." }, "academicSuffix_e08d883b5eae10000403d7c0735402e9": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The academic suffix for a relative name." }, "title_e08d883b5eae10000403d7b62abb02e7": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The prefix for a relative name." }, "hereditarySuffix_e08d883b5eae10000403d7efe24b02f3": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_ab5c028f50b310001b9916066f1f0250" }, {} ], "description": "The hereditary suffix for a relative name." }, "relativeNames_e08d883b5eae10000403d79fe6d202e3": { "allOf": [ { "type": "object", "properties": { "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 middle name for a relative name.", "x-workday-type": "Text" }, "royalSuffix": { "$ref": "#/definitions/royalSuffix_e08d883b5eae10000403d7d259db02ed" }, "religiousSuffix": { "$ref": "#/definitions/religiousSuffix_e08d883b5eae10000403d7eb401e02f2" }, "localPersonName": { "$ref": "#/definitions/localPersonName_e08d883b5eae10000403d7cd713c02ec" }, "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 family name for a relative name.", "x-workday-type": "Text" }, "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 relative name.", "x-workday-type": "Text" }, "honorarySuffix": { "$ref": "#/definitions/honorarySuffix_e08d883b5eae10000403d7acba9602e5" }, "country": { "$ref": "#/definitions/country_e08d883b5eae10000403d7c8e60502eb" }, "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 relative name", "x-workday-type": "Text" }, "salutationSuffix": { "$ref": "#/definitions/salutationSuffix_e08d883b5eae10000403d7d736c102ee" }, "relativeType": { "$ref": "#/definitions/relativeType_e08d883b5eae1000040cc1231a5902f5" }, "socialSuffix": { "$ref": "#/definitions/socialSuffix_e08d883b5eae10000403d7dc081502ef" }, "professionalSuffix": { "$ref": "#/definitions/professionalSuffix_e08d883b5eae10000403d7e2171f02f0" }, "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 relative name, where provided. Workday only tracks Full Name for countries where the Full Name name component is used.", "x-workday-type": "Text" }, "academicSuffix": { "$ref": "#/definitions/academicSuffix_e08d883b5eae10000403d7c0735402e9" }, "title": { "$ref": "#/definitions/title_e08d883b5eae10000403d7b62abb02e7" }, "hereditarySuffix": { "$ref": "#/definitions/hereditarySuffix_e08d883b5eae10000403d7efe24b02f3" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Relative_Name_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "uniformServiceReserveStatus_b26f12db214d10000bf4b358ee390000": { "allOf": [ { "type": "object", "properties": { "uniformServiceReserveStatusCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Uniform Service Reserve Status Code", "x-workday-type": "Text" }, "inactive": { "type": "boolean", "example": true, "description": "The inactive flag.", "x-workday-type": "Boolean" }, "uniformServiceReserveStatusDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Uniform Service Reserve Status Description.", "x-workday-type": "Text" }, "uniformServiceReserveStatusName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Uniform Service Reserve Status Name.", "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 \\~Uniform Service Reserve Status\\~" } } } ] }, "commonBooleanRepresentation_c6cfba790def100010efb5c8ebf00000": { "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 Common Boolean Enumeration" } } } ] }, "politicalAffiliation_6de928ab128410005b04f3329eee0214": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Political_Affiliation_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "disability_15d8b82e323110000d98d0fc4d9903a5": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Disability_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "disabilityCertificationBasis_15d8b82e323110000db825167ee603a9": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Disability_Certification_Basis_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "disabilityGrade_15d8b82e323110000ddf3ff73d2e03ae": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Disability_Grade_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "workerDocument_15d8b82e323110000e0117c92d9803b2": { "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 filename of the Worker Document.", "maxLength": 255, "x-workday-type": "Text" }, "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 additional comments associated with the Worker Document.", "x-workday-type": "Text" }, "File_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "disability_6de928ab128410005c56a64ec69f024f": { "allOf": [ { "$ref": "#/definitions/disability_15d8b82e323110000d98d0fc4d9903a5" }, {} ], "description": "The \\~Disability\\~ for a \\~Disability\\~ Status." }, "certificationBasis_6de928ab128410005c56a638b9d4024c": { "allOf": [ { "$ref": "#/definitions/disabilityCertificationBasis_15d8b82e323110000db825167ee603a9" }, {} ], "description": "The Certification Basis for a \\~Disability\\~ status." }, "grade_6de928ab128410005c56a5feed2e0244": { "allOf": [ { "$ref": "#/definitions/disabilityGrade_15d8b82e323110000ddf3ff73d2e03ae" }, {} ], "description": "The Grade for a \\~Disability\\~ status." }, "disabilityStatus_6de928ab128410005c56a5a5299c0239": { "allOf": [ { "type": "object", "properties": { "disability": { "$ref": "#/definitions/disability_6de928ab128410005c56a64ec69f024f" }, "certificationID": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Certification ID for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "certificationBasis": { "$ref": "#/definitions/certificationBasis_6de928ab128410005c56a638b9d4024c" }, "grade": { "$ref": "#/definitions/grade_6de928ab128410005c56a5feed2e0244" }, "rehabilitationProvided": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Rehabilitation Provided for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "workRestrictions": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Work Restrictions for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "accommodationRequested": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Accommodations Requested for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "certifiedBy": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The \\~Disability\\~ Authority for a \\~Disability\\~ Status", "x-workday-type": "Text" }, "statusDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The \\~Disability\\~ Status Date for a \\~Disability\\~ Status.", "x-workday-type": "Date" }, "degreePercent": { "type": "number", "example": 999999.99, "description": "The Degree for a \\~Disability\\~ status.", "x-workday-type": "Numeric" }, "knownDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The Date Known for a \\~Disability\\~ status.", "x-workday-type": "Date" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The End Date for a \\~Disability\\~ status.", "x-workday-type": "Date" }, "accommodationProvided": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Accommodations Provided for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "certifiedAt": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Certification Location for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "severityRecognitionDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The Severity Recognition Date for a \\~Disability\\~ status.", "x-workday-type": "Date" }, "workerDocuments": { "type": "array", "description": "The Worker Documents for this Disability Status.", "items": { "$ref": "#/definitions/workerDocument_15d8b82e323110000e0117c92d9803b2" }, "x-workday-type": "Multi-instance" }, "note": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Note for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "remainingCapacity": { "type": "number", "example": 999999.99, "description": "The Remaining Capacity for a \\~Disability\\~ status.", "x-workday-type": "Numeric" }, "statusID": { "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 \\~disability\\~ status. This is the unique identifier for the \\~disability\\~ status that is assigned at creation and then maintained throughout its life as it is edited.", "x-workday-type": "Text" }, "fteTowardQuota": { "type": "number", "example": 99999999999.9, "description": "The FTE Toward Quota for a \\~Disability\\~ status.", "x-workday-type": "Numeric" }, "rehabilitationRequested": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Rehabilitation Requested for a \\~Disability\\~ status.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "religion_6de928ab128410005a7df872e147020e": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Religion_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "aboriginalIndigenousIdentification_37580627f49d10002587d93d0a820000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Aboriginal/Indigenous_Identification_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "aboriginalIndigenousDetails_37580627f49d1000257d05e999ea0000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Aboriginal/Indigenous_Details_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "location_80df32d43a5810000d59f391b32400d8": { "allOf": [ { "$ref": "#/definitions/location_aaeb64c958b2100011f0c7fc94120224" }, {} ], "description": "Country for the Social Benefits Locality." }, "socialBenefitsLocality_80df32d43a5810000ce11ade29d300bc": { "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": "Description for the Social Benefits Locality.", "x-workday-type": "Text" }, "inactive": { "type": "boolean", "example": true, "description": "True if the Social Benefits Locality is inactive.", "x-workday-type": "Boolean" }, "location": { "$ref": "#/definitions/location_80df32d43a5810000d59f391b32400d8" }, "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Name for the Social Benefits Locality.", "x-workday-type": "Text" }, "code": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Code for the Social Benefits Locality.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Social_Benefits_Locality_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "gender_6de928ab12841000544f9cd350c201b9": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Gender_Code": { "type": "string", "description": "Reference id of the instance" } } } ] }, "veteransPreference_898f4bc8578c100010cc072a1b140000": { "allOf": [ { "type": "object", "properties": { "militaryServicePreferenceName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "\\~Veteran's Preference\\~ Category", "x-workday-type": "Text" }, "militaryServicePreferenceCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Military Service Preference Code", "x-workday-type": "Text" }, "inactive": { "type": "boolean", "example": true, "description": "The Inactive flag.", "x-workday-type": "Boolean" }, "militaryServicePreferenceDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Military Service Preference Description", "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 Veterans Preference" } } } ] }, "lgbtIdentification_6de928ab128410005a65d120bc8c020a": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "LGBT_Identification_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "country_6de928ab12841000549fe6404b2101c3": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "The Country of Birth for a person.", "x-conditionally-hidden": true }, "region_6de928ab12841000549fe6375a9301c2": { "allOf": [ { "$ref": "#/definitions/region_ab827579ee1710001f7eb5159a9b0170" }, {} ], "description": "The Region of Birth for a person.", "x-conditionally-hidden": true }, "placeOfBirth_6de928ab12841000549fe623b1ab01c0": { "allOf": [ { "type": "object", "properties": { "country": { "$ref": "#/definitions/country_6de928ab12841000549fe6404b2101c3" }, "region": { "$ref": "#/definitions/region_6de928ab12841000549fe6375a9301c2" }, "city": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The City of Birth for a person.", "x-workday-type": "Text", "x-conditionally-hidden": true } } } ] }, "location_6de928ab128410005960a25f7ff401e5": { "allOf": [ { "$ref": "#/definitions/location_aaeb64c958b2100011f0c7fc94120224" }, {} ], "description": "The country or country region for an Ethnicity." }, "ethnicity_6de928ab1284100058892e53dac501d1": { "allOf": [ { "type": "object", "properties": { "location": { "$ref": "#/definitions/location_6de928ab128410005960a25f7ff401e5" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Ethnicity_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "ethnicitiesForVisualSurvey_ebff7995b021100014bbd5c6cff700ae": { "allOf": [ { "type": "object", "properties": { "hispanicOrLatinoForVisualSurvey": { "type": "boolean", "example": true, "description": "True if the person is indicated as Hispanic or Latino for visual survey.", "x-workday-type": "Boolean" }, "ethnicities": { "type": "array", "description": "The ethnicities indicated on the person's visual survey.", "items": { "$ref": "#/definitions/ethnicity_6de928ab1284100058892e53dac501d1" }, "x-workday-type": "Multi-instance" } } } ] }, "country_80df32d43a5810000f9d096f27060127": { "allOf": [ { "$ref": "#/definitions/country_8beeb162738910001433a1ef009a01d0" }, {} ], "description": "Country for the Citizenship Status." }, "citizenshipStatus_80df32d43a5810000f452a84da970114": { "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": "Name for the Citizenship Status.", "x-workday-type": "Text" }, "description": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Description for the Citizenship Status.", "x-workday-type": "Text" }, "citizen": { "type": "boolean", "example": true, "description": "Identifies Citizenship Status as citizen.", "x-workday-type": "Boolean" }, "inactive": { "type": "boolean", "example": true, "description": "True if the Citizenship Status is inactive.", "x-workday-type": "Boolean" }, "country": { "$ref": "#/definitions/country_80df32d43a5810000f9d096f27060127" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Citizenship_Status_Code": { "type": "string", "description": "Reference id of the instance" } } } ] }, "bloodType_6de928ab1284100056beb6e9884101cd": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Blood_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "additionalNationalities_2b5dded3d48e100013ddc22953ee013a": { "allOf": [ { "$ref": "#/definitions/countryAndNationality_06544db2578d10000ec1cd4257350000" }, { "properties": { "id": { "type": "string", "description": "The id for Country and Nationality \nExample(s): ISO_3166-1_Alpha-3_Code=Sample_Value, ISO_3166-1_Numeric-3_Code=Sample_Value, ISO_3166-1_Alpha-2_Code=Sample_Value, Non-Country_Nationality=Sample_Value" } } } ] }, "veteransPreference_349dc615e38410001acc1309d9850000": { "allOf": [ { "$ref": "#/definitions/veteransPreference_898f4bc8578c100010cc072a1b140000" }, { "properties": { "id": { "type": "string", "description": "The id for Veterans Preference" } } } ] }, "usageType_81f66ab16f7510005c6076c4248b4875": { "allOf": [ { "$ref": "#/definitions/usageType_901718dd5e7910000cc03935c73e029c" }, {} ], "description": "Returns the usage type for a given communication method." }, "usedFor_81f66ab16f7510005c6076c64b544876": { "allOf": [ { "$ref": "#/definitions/usageBehavior_33e26848dc0010003a3c3827858901b4" }, { "properties": { "id": { "type": "string", "description": "The id for Communication Usage Behavior Mixed (Derived) \nExample(s): Communication_Usage_Behavior_ID=Sample_Value, Communication_Usage_Behavior_Tenanted_ID=Sample_Value" } } } ] }, "workContactUsage_81f66ab16f7510005c60769e6db24871": { "allOf": [ { "type": "object", "properties": { "usageType": { "$ref": "#/definitions/usageType_81f66ab16f7510005c6076c4248b4875" }, "primary": { "type": "boolean", "example": true, "description": "Returns Boolean Value False", "x-workday-type": "Boolean" }, "public": { "type": "boolean", "example": true, "description": "Is Public Visibility", "x-workday-type": "Boolean" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Returns the description for a given communication method.", "x-workday-type": "Text" }, "usedFor": { "type": "array", "description": "Used For", "items": { "$ref": "#/definitions/usedFor_81f66ab16f7510005c6076c64b544876" }, "x-workday-type": "Multi-instance" } } } ] } } }