{ "swagger": "2.0", "info": { "description": "The time tracking REST APIs enable you to access time tracking information. These APIs provide the ability to: \n* Enable workers to check in and check out of work and to review and modify their recent check-ins and check-outs. \n\n* Enable managers to check in and check out of work for a worker.\n\n* View workers who are currently checked in for work.\n\n* Review and modify a worker's check-ins and check-outs. \n\n* View and create time blocks.\n\n* View time entry validations for a worker.\n\n* View period schedule for a worker.", "version": "v6", "title": "timeTracking", "x-workday-confidence-level": "Production", "x-workday-internal-source": "xo", "x-workday-internal-routing": "Public", "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-service-container-id": "ba74f44bc90e107329f638ba9689003b" }, "host": "", "basePath": "/timeTracking/v6", "tags": [ { "name": "timeAttestationPrompts", "description": "Provides the ability to get the time attestation prompts that a worker would need to answer when checking in or out. Use all four fields of timeZone, worker, eventType, and dateTime to simulate the time clock event to retrieve the prompts that would be available on desktop. The prompts and their responses will be used to create worker time attestations. These worker time attestations would then be used when creating the actual time clock events.", "x-workday-confidence-level": "Production" }, { "name": "timeClockEvents", "description": "These public APIs are designed to open up foundational Time Tracking functionality in REST. Use this API to give employees the ability to check in and check out of work and to review and modify their recent check-ins and check-outs. You can also use this API to enable managers to check in and check out of work for a worker, to view workers who are currently checked in for work, and to review and modify a worker's check-ins and check-outs." }, { "name": "timeValidations", "description": "Provides access to custom time entry validation information in Workday. These REST APIs enable employees to view validations related to the time they just entered, and managers to view validations related to the time they are reviewing." }, { "name": "workerTimeAttestation", "description": "Provides access to worker time attestation information in Workday. These REST APIs enable users to view worker time attestations related to the time entered and to create worker time attestations. There is no query. To view a worker time attestation provide the ID in the URL. IDs are returned in the workerTimeAttestation field of GET /timeClockEvent and in the ID field of POST /workerTimeAttestation." }, { "name": "workerTimeBlocks", "description": "Provides access to worker time block information in Workday." }, { "name": "workers", "description": "Retrieves staffing information about workers. This resource also provides the ability to create, update, delete, and archive check-ins and check-in topics." }, { "name": "Prompt Values", "description": "Retrieves instances that can be used as values for other endpoint parameters in this service." } ], "schemes": [ "https" ], "paths": { "/workerTimeAttestation/{ID}/followupWorkerTimeAttestation": { "get": { "tags": [ "workerTimeAttestation" ], "description": "\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/workerTimeAttestationView_1beff00ce821100020d7c3b93f4d0000" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2822 | Specify a value for comment. |\n| Critical | A2824 | Specify a response. |\n| Critical | A2825 | This workerTimeAttestation has no followup time attestation prompt to answer: [parentWorkerTimeAttestation]. |\n| Critical | A2831 | Specify a prompt. |\n| Critical | A2832 | Specify a valid response. This response isn't valid for this time attestation prompt: [timeAttestationPromptResponse]. |\n| Critical | A2835 | Specify a valid followup time attestation prompt. This prompt isn't a valid followup time attestation prompt to [workerTimeAttestation]. |", "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": "a1d4845f6ddd100014f5c59b24ae0000", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] } }, "/timeValidations": { "get": { "tags": [ "timeValidations" ], "summary": "Retrieves a collection of time entry validations.", "description": "Retrieves a collection of time entry validations for the specified worker on the specified date. This method requires the date and worker query parameters.\n\nThe validation messages returned by this method indicate that the time entries failed the critical or warning custom validations configured in the Maintain Time Entry Validations task.\n\nSecured By Domain: Process: Time Block REST APIs\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "name": "date", "in": "query", "description": "The required date that determines the time entry validations. The method validates the time entries within week or time period of the specified date.", "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": "worker", "in": "query", "description": "The required Workday ID of the worker who entered the time entries.", "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/timeValidationView_76581637ef2410001ded866e9111001a" } } } } }, "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": "aecc266715b010001358273a212917f5", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs" ] } }, "/values/timeTypes/timeEntryCodes/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "date", "in": "query", "description": "The effective date to look up time types for a given worker.", "required": false, "type": "string", "format": "date" }, { "name": "inOutCodeOnly", "in": "query", "description": "If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event.", "required": false, "type": "boolean" }, { "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": "project", "in": "query", "description": "The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project.", "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" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker to look up time types for.", "required": false, "type": "string" } ] }, "/values/timeValues/positions/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "date", "in": "query", "description": "The effective date to look up time values for a given worker.", "required": false, "type": "string", "format": "date" }, { "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" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker to look up time values for.", "required": false, "type": "string" } ] }, "/workerTimeAttestation": { "post": { "tags": [ "workerTimeAttestation" ], "description": "\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "workerTimeAttestationCreate", "required": true, "schema": { "$ref": "#/definitions/workerTimeAttestationCreate_e6141de0347810001cba9a2683240000" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/workerTimeAttestationCreate_e6141de0347810001cba9a2683240000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2822 | Specify a value for comment. |\n| Critical | A2823 | Specify a valid eventType for the Worker for the specified date. This eventType isn't valid: [eventType]. Run the GET /values/timeValues/outReason to retrieve valid event types. |\n| Critical | A2824 | Specify a response. |\n| Critical | A2826 | Specify a value for dateTime. |\n| Critical | A2827 | The specified value is for a followup time attestation prompt: [timeAttestationRulePrompt]. Specify either a parent time attestation prompt or use this followup attestation prompt with a followup worker time attestation. |\n| Critical | A2828 | Specify a timeAttestationPrompt. Run the GET TimeAttestationPrompt operation to retrieve the valid time attestation prompts. |\n| Critical | A2829 | Specify a value for eventType. |\n| Critical | A2830 | Specify a valid time attestation prompt. This time attestation prompt isn't valid for this combination of worker, eventType, dateTime, and timeZone. |\n| Critical | A2832 | Specify a valid response. This response isn't valid for this time attestation prompt: [timeAttestationPromptResponse]. |\n| Critical | A2833 | Specify a value for worker. Run the GET worker operation to retrieve valid worker names and IDs. |\n| Critical | A2834 | Specify a value for timeZone. |", "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": "e6141de0347810001c8032fa71930000", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] } }, "/values/enterTimeByType/timeTypeNested/": { "get": { "tags": [ "Prompt Values" ], "description": "Provides a nested prompt for Time Tracking Time Types, similar prompt structure to the one provided in UI prompts. Currently does not support Time Offs.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/timeTypeNested_0b8f058ceccd100092100f7f84980000" } }, "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": "endDate", "in": "query", "description": "End date of the time period the worker is creating a time entry for.", "required": false, "type": "string", "format": "date" }, { "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" }, { "name": "startDate", "in": "query", "description": "Start date of the time period the worker is creating a time entry for.", "required": false, "type": "string", "format": "date" }, { "name": "worker", "in": "query", "description": "Worker for which Time Type is needed.", "required": false, "type": "string" } ] }, "/values/timeTypes/defaultTimeEntryCode/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "date", "in": "query", "description": "The effective date to look up time types for a given worker.", "required": false, "type": "string", "format": "date" }, { "name": "inOutCodeOnly", "in": "query", "description": "If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event.", "required": false, "type": "boolean" }, { "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": "project", "in": "query", "description": "The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project.", "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" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker to look up time types for.", "required": false, "type": "string" } ] }, "/workers/{ID}/workerTimeBlock": { "post": { "tags": [ "workers" ], "summary": "Creates a worker time block.", "description": "Creates a worker time block for the specified worker. Specify these required fields in the request body:\n\n* calendarDate and reportedQuantity - If the worker is hourly.\n\n* Time-in/time-out fields for an in/out worker - the shape of these fields depends on the API version. See the version comparison below.\n\n* One of timeEntryCode, project, or projectPlanTask. These fields are mutually exclusive. Specify 1 of these fields in the request body.\n\nFor the timeEntryCode id, you can use a returned id from GET /values/timeTypes/timeEntryCodes, which returns the time entry codes that the given worker is eligible for on the given date. \n\nFor a valid project id, you can use a returned id from GET /values/timeTypes/projects, which you can filter by date and worker.\n\nFor a valid projectPlanTask id, you can use a returned id from GET /values/timeTypes/projectPlanTasks, which you can filter by date, worker, and project.\n\nVERSION COMPARISON - in/out time fields:\n\nv2 through v6 (legacy): use the flat fields inTime, outTime, inTimeZone, and outTimeZone. \n\nSample request body:\n\n{\n \"calendarDate\": \"2024-11-03\",\n \"inTime\": \"2024-11-03T01:00:00.000\",\n \"outTime\": \"2024-11-03T03:00:00.000\",\n \"inTimeZone\": \"America/Los_Angeles\",\n \"outTimeZone\": \"America/Los_Angeles\",\n \"timeEntryCode\": { \"id\": \"timeEntryCodeWID\" }\n}\n\nv7(current): use the nested inTimeWithTimeZone and outTimeWithTimeZone objects instead of the flat fields above. Each object requires 2 sub-fields: \na) timeZone (a valid IANA time zone identifier, for example America/Los_Angeles) \nb) dateTime (an ISO 8601 date-time with offset, for example 2024-11-03T01:00:00.000-07:00). \n\nSample request body:\n\n{\n \"calendarDate\": \"2024-11-03\",\n \"inTimeWithTimeZone\": {\n \"timeZone\": \"America/Los_Angeles\",\n \"dateTime\": \"2024-11-03T01:00:00.000-07:00\"\n },\n \"outTimeWithTimeZone\": {\n \"timeZone\": \"America/Los_Angeles\",\n \"dateTime\": \"2024-11-03T03:00:00.000-08:00\"\n },\n \"timeEntryCode\": { \"id\": \"timeEntryCodeWID\" }\n}\n\nNote: as of v7, the legacy flat inTime, outTime, inTimeZone, and outTimeZone fields are no longer accepted; requests submitted to v7 using those fields are rejected.\n\nSecured By Domain: Process: Time Block REST APIs\n\nScope: Time Tracking", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|me)$" }, { "in": "body", "name": "timeBlockView", "required": true, "schema": { "$ref": "#/definitions/timeBlockView_18442114504f100016031395a48200ee" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/timeBlockView_18442114504f100016031395a48200ee" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A693 | Remove Custom Organization 07. Custom Organization 07 is not allowed. |\n| Critical | A695 | Enter a Custom Organization 04. A Custom Organization 04 is required by the time entry code. |\n| Critical | A696 | Remove Custom Worktag 15. Custom Worktag 15 is not allowed. |\n| Critical | A697 | Enter a Custom Worktag 13. A Custom Worktag 13 is required by the time entry code. |\n| Critical | A699 | Period schedule does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A701 | Enter a Custom Worktag 02. A Custom Worktag 02 is required by the time entry code. |\n| Critical | A702 | Out Type [Out Type] is not valid for this time type [Time Entry Code]. Enter a valid Out Type. |\n| Critical | A703 | Remove Custom Organization 02. Custom Organization 02 is not allowed. |\n| Critical | A704 | More than 24 hours have been reported by the \\~worker\\~, [worker], on [date]. |\n| Critical | A705 | The field Out Reason is required and must have a value. |\n| Critical | A707 | Time Entry Code [tec] is not valid for [worker]. |\n| Critical | A708 | Remove Override Rate. Override Rate is not allowed by the time entry code. |\n| Critical | A710 | Enter a Custom Worktag 01. A Custom Worktag 01 is required by the time entry code. |\n| Critical | A711 | Remove Custom Worktag 03. Custom Worktag 03 is not allowed. |\n| Critical | A712 | Enter a Location. A Location is required by the time entry code. |\n| Critical | A713 | Remove Custom Worktag 10. Custom Worktag 10 is not allowed. |\n| Critical | A714 | Enter a Custom Worktag 04. A Custom Worktag 04 is required by the time entry code. |\n| Critical | A716 | Remove Project Plan Task because the time entry template is not configured for project time entry. |\n| Critical | A717 | Enter a Custom Organization 02. A Custom Organization 02 is required by the time entry code. |\n| Critical | A719 | Reported Quantity is not valid because the time type [Time Entry Code] is In/Out Time only. Enter an In Time and Out Time. |\n| Critical | A720 | Enter true in the Do Not Bill field. The reported project is not billable. |\n| Critical | A721 | Remove Cost Center. Cost Center is not allowed. |\n| Critical | A722 | Enter a Job Profile. A Job Profile is required by the time entry code. |\n| Critical | A723 | Remove Custom Worktag 13. Custom Worktag 13 is not allowed. |\n| Critical | A724 | Enter a Custom Worktag 06. A Custom Worktag 06 is required by the time entry code. |\n| Critical | A725 | Enter a Cost Center. A Cost Center is required by the time entry code. |\n| Critical | A727 | Remove Custom Organization 01. Custom Organization 01 is not allowed. |\n| Critical | A728 | Remove Custom Worktag 12. Custom Worktag 12 is not allowed. |\n| Critical | A729 | Remove Custom Organization 10. Custom Organization 10 is not allowed. |\n| Critical | A730 | Remove Region. Region is not allowed. |\n| Critical | A731 | Enter a Custom Organization 05. A Custom Organization 05 is required by the time entry code. |\n| Critical | A732 | Enter a Region. A Region is required by the time entry code. |\n| Critical | A733 | Calendar Date is not allowed for Time Entry Code - [Time Entry Code]. |\n| Critical | A734 | Time Entry Template does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A736 | Enter an Out Time. Out Time is required for time type - [Time Entry Code]. |\n| Critical | A737 | The Worker in the URL must match [worker]. |\n| Critical | A738 | Remove Custom Organization 05. Custom Organization 05 is not allowed. |\n| Critical | A739 | Enter a Gift. A Gift is required by the time entry code. |\n| Critical | A740 | Remove Location. Location is not allowed. |\n| Critical | A741 | Enter a Custom Organization 07. A Custom Organization 07 is required by the time entry code. |\n| Critical | A742 | Remove Business Unit. Business Unit is not allowed. |\n| Critical | A743 | Remove Project because the time entry template is not configured for project time entry. |\n| Critical | A744 | Hours must be entered in increments as specified on Time Entry Code [Time Entry Code] for [Worker]. |\n| Critical | A745 | Any time which crosses [week breaker] must be entered as two separate blocks. Enter one block before [week breaker] and one after. |\n| Critical | A746 | Remove Program. Program is not allowed. |\n| Critical | A747 | Enter a Custom Worktag 05. A Custom Worktag 05 is required by the time entry code. |\n| Critical | A748 | Remove Custom Organization 04. Custom Organization 04 is not allowed. |\n| Critical | A750 | Enter a Grant. A Grant is required by the time entry code. |\n| Critical | A751 | Remove Custom Worktag 05. Custom Worktag 05 is not allowed. |\n| Critical | A752 | Enter either a Time Entry Code, Project, or Project Plan Task. |\n| Critical | A753 | Enter a Fund. A Fund is required by the time entry code. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled]. |\n| Critical | A755 | Enter a Custom Worktag 08. A Custom Worktag 08 is required by the time entry code. |\n| Critical | A757 | Enter a Business Unit. A Business Unit is required by the time entry code. |\n| Critical | A758 | Time overlaps with existing time. You entered [in time] - [out time], which overlaps with the following existing entries: [existing entries]. |\n| Critical | A759 | Out Date Time must be greater than In Date Time. |\n| Critical | A760 | Remove Custom Worktag 07. Custom Worktag 07 is not allowed. |\n| Critical | A761 | Remove Custom Organization 08. Custom Organization 08 is not allowed. |\n| Critical | A763 | Remove Custom Organization 09. Custom Organization 09 is not allowed. |\n| Critical | A764 | Remove Custom Worktag 09. Custom Worktag 09 is not allowed. |\n| Critical | A765 | In Time Zone and Out Time Zone are not valid for the time type [Time Entry Code]. Enter a Calendar Date. |\n| Critical | A766 | Remove Custom Worktag 01. Custom Worktag 01 is not allowed. |\n| Critical | A767 | Enter a Custom Organization 06. A Custom Organization 06 is required by the time entry code. |\n| Critical | A768 | Remove Custom Worktag 02. Custom Worktag 02 is not allowed. |\n| Critical | A769 | Enter a Custom Organization 09. A Custom Organization 09 is required by the time entry code. |\n| Critical | A770 | Enter a Custom Worktag 11. A Custom Worktag 11 is required by the time entry code. |\n| Critical | A771 | Enter a Reported Quantity. Reported Quantity is required for time type - [Time Entry Code]. |\n| Critical | A773 | Remove Fund. Fund is not allowed. |\n| Critical | A774 | Remove Custom Worktag 08. Custom Worktag 08 is not allowed. |\n| Critical | A776 | Enter a Custom Worktag 15. A Custom Worktag 15 is required by the time entry code. |\n| Critical | A777 | Remove Grant. Grant is not allowed. |\n| Critical | A778 | The [worktag type] entered for [worker] on [date] is inactive. Remove or replace it to proceed. |\n| Critical | A780 | [worker] cannot use the project, [project], to report the time on [date]. |\n| Critical | A781 | Enter an Out Time Zone. Out Time Zone is required for time type - [time entry code]. |\n| Critical | A783 | Remove Job Profile. Job Profile is not allowed. |\n| Critical | A784 | Remove Custom Organization 03. Custom Organization 03 is not allowed. |\n| Critical | A785 | Enter a Custom Organization 08. A Custom Organization 08 is required by the time entry code. |\n| Critical | A786 | Enter either a Calendar Date or these fields: In Time, Out Time, In Time Zone, Out Time Zone. |\n| Critical | A787 | Enter a Position. Position is required for \\~workers\\~ with multiple positions. |\n| Critical | A788 | Enter a Custom Worktag 03. A Custom Worktag 03 is required by the time entry code. |\n| Critical | A789 | [date] is locked for time entry for [worker]. |\n| Critical | A790 | Remove Custom Organization 06. Custom Organization 06 is not allowed. |\n| Critical | A791 | Enter a Custom Worktag 07. A Custom Worktag 07 is required by the time entry code. |\n| Critical | A792 | Remove Custom Worktag 04. Custom Worktag 04 is not allowed. |\n| Critical | A795 | Remove Custom Worktag 06. Custom Worktag 06 is not allowed. |\n| Critical | A796 | The following worktags are required: [related_required_worktags]. |\n| Critical | A797 | [worker] cannot use the task, [task], to report time on [date]. |\n| Critical | A798 | Enter a \\~Worker\\~. |\n| Critical | A799 | Enter a Custom Worktag 10. A Custom Worktag 10 is required by the time entry code. |\n| Critical | A800 | Enter an In Time Zone. In Time Zone is required for time type - [time entry code]. |\n| Critical | A801 | Enter an In Time. In Time is required for time type - [Time Entry Code]. |\n| Critical | A802 | Enter a Custom Worktag 12. A Custom Worktag 12 is required by the time entry code. |\n| Critical | A803 | Remove Gift. Gift is not allowed. |\n| Critical | A804 | Enter a Custom Organization 01. A Custom Organization 01 is required by the time entry code. |\n| Critical | A805 | Enter a Program. A Program is required by the time entry code. |\n| Critical | A806 | Enter a Custom Worktag 09. A Custom Worktag 09 is required by the time entry code. |\n| Critical | A807 | Remove Custom Worktag 14. Custom Worktag 14 is not allowed. |\n| Critical | A808 | In Time and Out Time are not valid for the time type [Time Entry Code]. Enter a Reported Quantity in [Units]. |\n| Critical | A809 | Enter a Custom Organization 10. A Custom Organization 10 is required by the time entry code. |\n| Critical | A811 | Out Type is not valid for this time type [Time Entry Code]. Enter a Reported Quantity in [Units]. |\n| Critical | A812 | Enter a Calendar Date. Calendar Date is required for time type - [Time Entry Code]. |\n| Critical | A814 | Enter a Custom Organization 03. A Custom Organization 03 is required by the time entry code. |\n| Critical | A815 | Remove Position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A815 | The position [position] is not valid for [worker] on [time block reported date]. |\n| Critical | A816 | Enter a Custom Worktag 14. A Custom Worktag 14 is required by the time entry code. |\n| Critical | A817 | Remove Custom Worktag 11. Custom Worktag 11 is not allowed. |\n| Critical | A935 | You are not eligible to enter against the \\~project role\\~. |\n| Critical | A936 | You cannot enter a \\~project role\\~. |\n| Critical | A937 | Enter a \\~project role\\~. \\~Project role\\~ is required for \\~workers\\~ with multiple \\~project roles\\~. |\n| Critical | A938 | The field Comment is required and must have a value. |\n| Critical | A1261 | Enter an Appropriation. An Appropriation is required by the time entry code. |\n| Critical | A1262 | Enter an Allocation Pool. An Allocation Pool is required by the time entry code. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A3083 | You can't create or edit the time block for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "498aa253df7d10002817eb4ed57b023f", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs" ] } }, "/workers": { "get": { "tags": [ "workers" ], "summary": "Retrieves a collection of workers and current staffing information.", "description": "Retrieves a collection of workers and current staffing information.\n\nSecured By Domain: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports\n\nScope: Staffing", "produces": [ "application/json" ], "parameters": [ { "name": "filterByOrgVisibility", "in": "query", "description": "Only return workers whose supervisory organizations are visible to the processing user. This requires the 'Enable Restrictions on Worker Prompts Based on Supervisory Org Visibility Settings' setting to be enabled in Edit Tenant Setup - System.", "required": false, "type": "boolean" }, { "name": "includeTerminatedWorkers", "in": "query", "description": "Include terminated workers in the output", "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" }, { "name": "search", "in": "query", "description": "Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.", "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/workerData_c2466b0778c610000d1936006720000e" } } } } }, "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": "c2466b0778c610000cdf9abc4fbc000c", "x-workday-secured-by-domains": [ "FLW Service", "Self-Service: Current Staffing Information", "Worker Data: Public Worker Reports" ] } }, "/workers/{ID}/workerTimeBlock/{subresourceID}": { "delete": { "tags": [ "workers" ], "summary": "Deletes a specified worker time block.", "description": "Deletes a worker time block with the specified ID for the specified worker.\n\nSecured By Domain: Process: Time Block REST APIs\n\nScope: Time Tracking", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|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: Worker_Time_Block_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Worker_Time_Block_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 | A693 | Remove Custom Organization 07. Custom Organization 07 is not allowed. |\n| Critical | A695 | Enter a Custom Organization 04. A Custom Organization 04 is required by the time entry code. |\n| Critical | A696 | Remove Custom Worktag 15. Custom Worktag 15 is not allowed. |\n| Critical | A697 | Enter a Custom Worktag 13. A Custom Worktag 13 is required by the time entry code. |\n| Critical | A699 | Period schedule does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A701 | Enter a Custom Worktag 02. A Custom Worktag 02 is required by the time entry code. |\n| Critical | A702 | Out Type [Out Type] is not valid for this time type [Time Entry Code]. Enter a valid Out Type. |\n| Critical | A703 | Remove Custom Organization 02. Custom Organization 02 is not allowed. |\n| Critical | A704 | More than 24 hours have been reported by the \\~worker\\~, [worker], on [date]. |\n| Critical | A705 | The field Out Reason is required and must have a value. |\n| Critical | A706 | You can only delete user entered time blocks. |\n| Critical | A707 | Time Entry Code [tec] is not valid for [worker]. |\n| Critical | A708 | Remove Override Rate. Override Rate is not allowed by the time entry code. |\n| Critical | A710 | Enter a Custom Worktag 01. A Custom Worktag 01 is required by the time entry code. |\n| Critical | A711 | Remove Custom Worktag 03. Custom Worktag 03 is not allowed. |\n| Critical | A712 | Enter a Location. A Location is required by the time entry code. |\n| Critical | A713 | Remove Custom Worktag 10. Custom Worktag 10 is not allowed. |\n| Critical | A714 | Enter a Custom Worktag 04. A Custom Worktag 04 is required by the time entry code. |\n| Critical | A716 | Remove Project Plan Task because the time entry template is not configured for project time entry. |\n| Critical | A717 | Enter a Custom Organization 02. A Custom Organization 02 is required by the time entry code. |\n| Critical | A720 | Enter true in the Do Not Bill field. The reported project is not billable. |\n| Critical | A721 | Remove Cost Center. Cost Center is not allowed. |\n| Critical | A722 | Enter a Job Profile. A Job Profile is required by the time entry code. |\n| Critical | A723 | Remove Custom Worktag 13. Custom Worktag 13 is not allowed. |\n| Critical | A724 | Enter a Custom Worktag 06. A Custom Worktag 06 is required by the time entry code. |\n| Critical | A725 | Enter a Cost Center. A Cost Center is required by the time entry code. |\n| Critical | A727 | Remove Custom Organization 01. Custom Organization 01 is not allowed. |\n| Critical | A728 | Remove Custom Worktag 12. Custom Worktag 12 is not allowed. |\n| Critical | A729 | Remove Custom Organization 10. Custom Organization 10 is not allowed. |\n| Critical | A730 | Remove Region. Region is not allowed. |\n| Critical | A731 | Enter a Custom Organization 05. A Custom Organization 05 is required by the time entry code. |\n| Critical | A732 | Enter a Region. A Region is required by the time entry code. |\n| Critical | A734 | Time Entry Template does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A736 | Enter an Out Time. Out Time is required for time type - [Time Entry Code]. |\n| Critical | A737 | The Worker in the URL must match [worker]. |\n| Critical | A738 | Remove Custom Organization 05. Custom Organization 05 is not allowed. |\n| Critical | A739 | Enter a Gift. A Gift is required by the time entry code. |\n| Critical | A740 | Remove Location. Location is not allowed. |\n| Critical | A741 | Enter a Custom Organization 07. A Custom Organization 07 is required by the time entry code. |\n| Critical | A742 | Remove Business Unit. Business Unit is not allowed. |\n| Critical | A743 | Remove Project because the time entry template is not configured for project time entry. |\n| Critical | A744 | Hours must be entered in increments as specified on Time Entry Code [Time Entry Code] for [Worker]. |\n| Critical | A745 | Any time which crosses [week breaker] must be entered as two separate blocks. Enter one block before [week breaker] and one after. |\n| Critical | A746 | Remove Program. Program is not allowed. |\n| Critical | A747 | Enter a Custom Worktag 05. A Custom Worktag 05 is required by the time entry code. |\n| Critical | A748 | Remove Custom Organization 04. Custom Organization 04 is not allowed. |\n| Critical | A750 | Enter a Grant. A Grant is required by the time entry code. |\n| Critical | A751 | Remove Custom Worktag 05. Custom Worktag 05 is not allowed. |\n| Critical | A753 | Enter a Fund. A Fund is required by the time entry code. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled]. |\n| Critical | A755 | Enter a Custom Worktag 08. A Custom Worktag 08 is required by the time entry code. |\n| Critical | A757 | Enter a Business Unit. A Business Unit is required by the time entry code. |\n| Critical | A758 | Time overlaps with existing time. You entered [in time] - [out time], which overlaps with the following existing entries: [existing entries]. |\n| Critical | A759 | Out Date Time must be greater than In Date Time. |\n| Critical | A760 | Remove Custom Worktag 07. Custom Worktag 07 is not allowed. |\n| Critical | A761 | Remove Custom Organization 08. Custom Organization 08 is not allowed. |\n| Critical | A763 | Remove Custom Organization 09. Custom Organization 09 is not allowed. |\n| Critical | A764 | Remove Custom Worktag 09. Custom Worktag 09 is not allowed. |\n| Critical | A765 | In Time Zone and Out Time Zone are not valid for the time type [Time Entry Code]. Enter a Calendar Date. |\n| Critical | A766 | Remove Custom Worktag 01. Custom Worktag 01 is not allowed. |\n| Critical | A767 | Enter a Custom Organization 06. A Custom Organization 06 is required by the time entry code. |\n| Critical | A768 | Remove Custom Worktag 02. Custom Worktag 02 is not allowed. |\n| Critical | A769 | Enter a Custom Organization 09. A Custom Organization 09 is required by the time entry code. |\n| Critical | A770 | Enter a Custom Worktag 11. A Custom Worktag 11 is required by the time entry code. |\n| Critical | A771 | Enter a Reported Quantity. Reported Quantity is required for time type - [Time Entry Code]. |\n| Critical | A773 | Remove Fund. Fund is not allowed. |\n| Critical | A774 | Remove Custom Worktag 08. Custom Worktag 08 is not allowed. |\n| Critical | A776 | Enter a Custom Worktag 15. A Custom Worktag 15 is required by the time entry code. |\n| Critical | A777 | Remove Grant. Grant is not allowed. |\n| Critical | A778 | The [worktag type] entered for [worker] on [date] is inactive. Remove or replace it to proceed. |\n| Critical | A780 | [worker] cannot use the project, [project], to report the time on [date]. |\n| Critical | A781 | Enter an Out Time Zone. Out Time Zone is required for time type - [time entry code]. |\n| Critical | A783 | Remove Job Profile. Job Profile is not allowed. |\n| Critical | A784 | Remove Custom Organization 03. Custom Organization 03 is not allowed. |\n| Critical | A785 | Enter a Custom Organization 08. A Custom Organization 08 is required by the time entry code. |\n| Critical | A786 | Enter either a Calendar Date or these fields: In Time, Out Time, In Time Zone, Out Time Zone. |\n| Critical | A787 | Enter a Position. Position is required for \\~workers\\~ with multiple positions. |\n| Critical | A788 | Enter a Custom Worktag 03. A Custom Worktag 03 is required by the time entry code. |\n| Critical | A789 | [date] is locked for time entry for [worker]. |\n| Critical | A790 | Remove Custom Organization 06. Custom Organization 06 is not allowed. |\n| Critical | A791 | Enter a Custom Worktag 07. A Custom Worktag 07 is required by the time entry code. |\n| Critical | A792 | Remove Custom Worktag 04. Custom Worktag 04 is not allowed. |\n| Critical | A795 | Remove Custom Worktag 06. Custom Worktag 06 is not allowed. |\n| Critical | A796 | The following worktags are required: [related_required_worktags]. |\n| Critical | A797 | [worker] cannot use the task, [task], to report time on [date]. |\n| Critical | A798 | Enter a \\~Worker\\~. |\n| Critical | A799 | Enter a Custom Worktag 10. A Custom Worktag 10 is required by the time entry code. |\n| Critical | A800 | Enter an In Time Zone. In Time Zone is required for time type - [time entry code]. |\n| Critical | A801 | Enter an In Time. In Time is required for time type - [Time Entry Code]. |\n| Critical | A802 | Enter a Custom Worktag 12. A Custom Worktag 12 is required by the time entry code. |\n| Critical | A803 | Remove Gift. Gift is not allowed. |\n| Critical | A804 | Enter a Custom Organization 01. A Custom Organization 01 is required by the time entry code. |\n| Critical | A805 | Enter a Program. A Program is required by the time entry code. |\n| Critical | A806 | Enter a Custom Worktag 09. A Custom Worktag 09 is required by the time entry code. |\n| Critical | A807 | Remove Custom Worktag 14. Custom Worktag 14 is not allowed. |\n| Critical | A808 | In Time and Out Time are not valid for the time type [Time Entry Code]. Enter a Reported Quantity in [Units]. |\n| Critical | A809 | Enter a Custom Organization 10. A Custom Organization 10 is required by the time entry code. |\n| Critical | A811 | Out Type is not valid for this time type [Time Entry Code]. Enter a Reported Quantity in [Units]. |\n| Critical | A812 | Enter a Calendar Date. Calendar Date is required for time type - [Time Entry Code]. |\n| Critical | A814 | Enter a Custom Organization 03. A Custom Organization 03 is required by the time entry code. |\n| Critical | A815 | Remove Position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A815 | The position [position] is not valid for [worker] on [time block reported date]. |\n| Critical | A816 | Enter a Custom Worktag 14. A Custom Worktag 14 is required by the time entry code. |\n| Critical | A817 | Remove Custom Worktag 11. Custom Worktag 11 is not allowed. |\n| Critical | A935 | You are not eligible to enter against the \\~project role\\~. |\n| Critical | A937 | Enter a \\~project role\\~. \\~Project role\\~ is required for \\~workers\\~ with multiple \\~project roles\\~. |\n| Critical | A938 | The field Comment is required and must have a value. |\n| Critical | A952 | You can't use Delete workerTimeBlock API to delete time entries that require a comment. |\n| Critical | A1261 | Enter an Appropriation. An Appropriation is required by the time entry code. |\n| Critical | A1262 | Enter an Allocation Pool. An Allocation Pool is required by the time entry code. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A2742 | You can't delete the time block for this worker on [date] because it's a billable transaction that's currently locked: [worker]. |\n| Critical | A3019 | You can't delete the time block for [worker] on [date] because you don't have access to this time entry code: [time entry code]. |\n| Critical | A3083 | You can't create or edit the time block for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "3c3884d77e2f1000086dc71de2c900ab", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs" ] }, "patch": { "tags": [ "workers" ], "summary": "Updates a specified worker time block.", "description": "Updates the worker time block for the specified worker with the specified data in the request body. \n\nThe timeEntryCode, project, and projectPlanTask fields are mutually exclusive. You can only specify 1 of these fields in the request body.\n\nFor the timeEntryCode id, you can use a returned id from GET /values/timeTypes/timeEntryCodes, which returns the time entry codes that the given worker is eligible for on the given date. \n\nFor a valid project id, you can use a returned id from GET /values/timeTypes/projects, which you can filter by date and worker.\n\nFor a valid projectPlanTask id, you can use a returned id from GET /values/timeTypes/projectPlanTasks, which you can filter by date, worker, and project.\n\nSecured By Domain: Process: Time Block REST APIs\n\nScope: Time Tracking", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|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: Worker_Time_Block_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Worker_Time_Block_ID)=\\S+)$" }, { "in": "body", "name": "timeBlockView", "required": true, "schema": { "$ref": "#/definitions/timeBlockView_18442114504f100016031395a48200ee" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/timeBlockView_18442114504f100016031395a48200ee" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A693 | Remove Custom Organization 07. Custom Organization 07 is not allowed. |\n| Critical | A695 | Enter a Custom Organization 04. A Custom Organization 04 is required by the time entry code. |\n| Critical | A696 | Remove Custom Worktag 15. Custom Worktag 15 is not allowed. |\n| Critical | A697 | Enter a Custom Worktag 13. A Custom Worktag 13 is required by the time entry code. |\n| Critical | A699 | Period schedule does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A701 | Enter a Custom Worktag 02. A Custom Worktag 02 is required by the time entry code. |\n| Critical | A702 | Out Type [Out Type] is not valid for this time type [Time Entry Code]. Enter a valid Out Type. |\n| Critical | A703 | Remove Custom Organization 02. Custom Organization 02 is not allowed. |\n| Critical | A704 | More than 24 hours have been reported by the \\~worker\\~, [worker], on [date]. |\n| Critical | A705 | The field Out Reason is required and must have a value. |\n| Critical | A706 | You can only edit user entered time blocks. |\n| Critical | A707 | Time Entry Code [tec] is not valid for [worker]. |\n| Critical | A708 | Remove Override Rate. Override Rate is not allowed by the time entry code. |\n| Critical | A710 | Enter a Custom Worktag 01. A Custom Worktag 01 is required by the time entry code. |\n| Critical | A711 | Remove Custom Worktag 03. Custom Worktag 03 is not allowed. |\n| Critical | A712 | Enter a Location. A Location is required by the time entry code. |\n| Critical | A713 | Remove Custom Worktag 10. Custom Worktag 10 is not allowed. |\n| Critical | A714 | Enter a Custom Worktag 04. A Custom Worktag 04 is required by the time entry code. |\n| Critical | A716 | Remove Project Plan Task because the time entry template is not configured for project time entry. |\n| Critical | A717 | Enter a Custom Organization 02. A Custom Organization 02 is required by the time entry code. |\n| Critical | A718 | Reported Quantity can't be changed because the time type [Time Entry Code] is In/Out Time only. Enter an In Time and Out Time. |\n| Critical | A720 | Enter true in the Do Not Bill field. The reported project is not billable. |\n| Critical | A721 | Remove Cost Center. Cost Center is not allowed. |\n| Critical | A722 | Enter a Job Profile. A Job Profile is required by the time entry code. |\n| Critical | A723 | Remove Custom Worktag 13. Custom Worktag 13 is not allowed. |\n| Critical | A724 | Enter a Custom Worktag 06. A Custom Worktag 06 is required by the time entry code. |\n| Critical | A725 | Enter a Cost Center. A Cost Center is required by the time entry code. |\n| Critical | A726 | In time date must match calendar date. |\n| Critical | A727 | Remove Custom Organization 01. Custom Organization 01 is not allowed. |\n| Critical | A728 | Remove Custom Worktag 12. Custom Worktag 12 is not allowed. |\n| Critical | A729 | Remove Custom Organization 10. Custom Organization 10 is not allowed. |\n| Critical | A730 | Remove Region. Region is not allowed. |\n| Critical | A731 | Enter a Custom Organization 05. A Custom Organization 05 is required by the time entry code. |\n| Critical | A732 | Enter a Region. A Region is required by the time entry code. |\n| Critical | A734 | Time Entry Template does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A736 | Enter an Out Time. Out Time is required for time type - [Time Entry Code]. |\n| Critical | A737 | The Worker in the URL must match [worker]. |\n| Critical | A738 | Remove Custom Organization 05. Custom Organization 05 is not allowed. |\n| Critical | A739 | Enter a Gift. A Gift is required by the time entry code. |\n| Critical | A740 | Remove Location. Location is not allowed. |\n| Critical | A741 | Enter a Custom Organization 07. A Custom Organization 07 is required by the time entry code. |\n| Critical | A742 | Remove Business Unit. Business Unit is not allowed. |\n| Critical | A743 | Remove Project because the time entry template is not configured for project time entry. |\n| Critical | A744 | Hours must be entered in increments as specified on Time Entry Code [Time Entry Code] for [Worker]. |\n| Critical | A745 | Any time which crosses [week breaker] must be entered as two separate blocks. Enter one block before [week breaker] and one after. |\n| Critical | A746 | Remove Program. Program is not allowed. |\n| Critical | A747 | Enter a Custom Worktag 05. A Custom Worktag 05 is required by the time entry code. |\n| Critical | A748 | Remove Custom Organization 04. Custom Organization 04 is not allowed. |\n| Critical | A750 | Enter a Grant. A Grant is required by the time entry code. |\n| Critical | A751 | Remove Custom Worktag 05. Custom Worktag 05 is not allowed. |\n| Critical | A752 | Edit either a Time Entry Code, Project, or Project Plan Task. |\n| Critical | A753 | Enter a Fund. A Fund is required by the time entry code. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled]. |\n| Critical | A755 | Enter a Custom Worktag 08. A Custom Worktag 08 is required by the time entry code. |\n| Critical | A756 | Worker can't be changed. |\n| Critical | A757 | Enter a Business Unit. A Business Unit is required by the time entry code. |\n| Critical | A758 | Time overlaps with existing time. You entered [in time] - [out time], which overlaps with the following existing entries: [existing entries]. |\n| Critical | A759 | Out Date Time must be greater than In Date Time. |\n| Critical | A760 | Remove Custom Worktag 07. Custom Worktag 07 is not allowed. |\n| Critical | A761 | Remove Custom Organization 08. Custom Organization 08 is not allowed. |\n| Critical | A763 | Remove Custom Organization 09. Custom Organization 09 is not allowed. |\n| Critical | A764 | Remove Custom Worktag 09. Custom Worktag 09 is not allowed. |\n| Critical | A765 | In Time Zone and Out Time Zone are not valid for the time type [Time Entry Code]. Enter a Calendar Date. |\n| Critical | A766 | Remove Custom Worktag 01. Custom Worktag 01 is not allowed. |\n| Critical | A767 | Enter a Custom Organization 06. A Custom Organization 06 is required by the time entry code. |\n| Critical | A768 | Remove Custom Worktag 02. Custom Worktag 02 is not allowed. |\n| Critical | A769 | Enter a Custom Organization 09. A Custom Organization 09 is required by the time entry code. |\n| Critical | A770 | Enter a Custom Worktag 11. A Custom Worktag 11 is required by the time entry code. |\n| Critical | A771 | Enter a Reported Quantity. Reported Quantity is required for time type - [Time Entry Code]. |\n| Critical | A772 | Calendar Date can't be changed on the time block. |\n| Critical | A773 | Remove Fund. Fund is not allowed. |\n| Critical | A774 | Remove Custom Worktag 08. Custom Worktag 08 is not allowed. |\n| Critical | A776 | Enter a Custom Worktag 15. A Custom Worktag 15 is required by the time entry code. |\n| Critical | A777 | Remove Grant. Grant is not allowed. |\n| Critical | A778 | The [worktag type] entered for [worker] on [date] is inactive. Remove or replace it to proceed. |\n| Critical | A780 | [worker] cannot use the project, [project], to report the time on [date]. |\n| Critical | A781 | Enter an Out Time Zone. Out Time Zone is required for time type - [time entry code]. |\n| Critical | A783 | Remove Job Profile. Job Profile is not allowed. |\n| Critical | A784 | Remove Custom Organization 03. Custom Organization 03 is not allowed. |\n| Critical | A785 | Enter a Custom Organization 08. A Custom Organization 08 is required by the time entry code. |\n| Critical | A786 | Enter either a Calendar Date or these fields: In Time, Out Time, In Time Zone, Out Time Zone. |\n| Critical | A787 | Enter a Position. Position is required for \\~workers\\~ with multiple positions. |\n| Critical | A788 | Enter a Custom Worktag 03. A Custom Worktag 03 is required by the time entry code. |\n| Critical | A789 | [date] is locked for time entry for [worker]. |\n| Critical | A790 | Remove Custom Organization 06. Custom Organization 06 is not allowed. |\n| Critical | A791 | Enter a Custom Worktag 07. A Custom Worktag 07 is required by the time entry code. |\n| Critical | A792 | Remove Custom Worktag 04. Custom Worktag 04 is not allowed. |\n| Critical | A795 | Remove Custom Worktag 06. Custom Worktag 06 is not allowed. |\n| Critical | A796 | The following worktags are required: [related_required_worktags]. |\n| Critical | A797 | [worker] cannot use the task, [task], to report time on [date]. |\n| Critical | A798 | Enter a \\~Worker\\~. |\n| Critical | A799 | Enter a Custom Worktag 10. A Custom Worktag 10 is required by the time entry code. |\n| Critical | A800 | Enter an In Time Zone. In Time Zone is required for time type - [time entry code]. |\n| Critical | A801 | Enter an In Time. In Time is required for time type - [Time Entry Code]. |\n| Critical | A802 | Enter a Custom Worktag 12. A Custom Worktag 12 is required by the time entry code. |\n| Critical | A803 | Remove Gift. Gift is not allowed. |\n| Critical | A804 | Enter a Custom Organization 01. A Custom Organization 01 is required by the time entry code. |\n| Critical | A805 | Enter a Program. A Program is required by the time entry code. |\n| Critical | A806 | Enter a Custom Worktag 09. A Custom Worktag 09 is required by the time entry code. |\n| Critical | A807 | Remove Custom Worktag 14. Custom Worktag 14 is not allowed. |\n| Critical | A808 | In Time and Out Time are not valid for the time type [Time Entry Code]. Enter a Reported Quantity in [Units]. |\n| Critical | A809 | Enter a Custom Organization 10. A Custom Organization 10 is required by the time entry code. |\n| Critical | A811 | Out Type is not valid for this time type [Time Entry Code]. Enter a Reported Quantity in [Units]. |\n| Critical | A812 | Enter a Calendar Date. Calendar Date is required for time type - [Time Entry Code]. |\n| Critical | A814 | Enter a Custom Organization 03. A Custom Organization 03 is required by the time entry code. |\n| Critical | A815 | Remove Position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A815 | The position [position] is not valid for [worker] on [time block reported date]. |\n| Critical | A816 | Enter a Custom Worktag 14. A Custom Worktag 14 is required by the time entry code. |\n| Critical | A817 | Remove Custom Worktag 11. Custom Worktag 11 is not allowed. |\n| Critical | A935 | You are not eligible to enter against the \\~project role\\~. |\n| Critical | A936 | You cannot enter a \\~project role\\~. |\n| Critical | A937 | Enter a \\~project role\\~. \\~Project role\\~ is required for \\~workers\\~ with multiple \\~project roles\\~. |\n| Critical | A938 | The field Comment is required and must have a value. |\n| Critical | A946 | This time entry is locked for revenue purposes. |\n| Critical | A1261 | Enter an Appropriation. An Appropriation is required by the time entry code. |\n| Critical | A1262 | Enter an Allocation Pool. An Allocation Pool is required by the time entry code. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A3038 | You can't edit the time block for [worker] on [date] because you don't have access to this time entry code: [time entry code on the time block]. |\n| Critical | A3083 | You can't create or edit the time block for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "e8387945b166100017f3a1bbb30600f4", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs" ] } }, "/workers/{ID}/timeTotals": { "get": { "tags": [ "workers" ], "summary": "Retrieves a summary of reported hours for a worker over a period.", "description": "Retrieves a summary of reported hours for a worker over a period. The period contains the specified date or, if not specified, it contains today's date.\n\nSecured By Domain: Process: Time Block REST APIs, Process: Time Clock Event REST API's\n\nScope: Time Tracking", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|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": "periodDate", "in": "query", "description": "Contains the specified date used to match to a period containing the date. The default is today's date.", "required": false, "type": "string", "format": "date" } ], "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/periodTotalSummary_c649d8a6912a10000d519b738a2c0070" } } } } }, "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": "177cde337c80100033390ff6f590001e", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs", "Process: Time Clock Event REST API's" ] } }, "/workerTimeBlocks/{ID}": { "get": { "tags": [ "workerTimeBlocks" ], "summary": "Retrieves a worker time block.", "description": "Retrieves a worker time block with the specified ID.\n\nSecured By Domain: Process: Time Block REST APIs\n\nScope: Time Tracking", "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: Worker_Time_Block_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Worker_Time_Block_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/timeBlockView_18442114504f100016031395a48200ee" } }, "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": "c56c2303fe6b1000116402a0024f00ea", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs" ] } }, "/workers/{ID}/timeReviewEvents": { "post": { "tags": [ "workers" ], "summary": "Adds time review events for the specified worker.", "description": "Creates a time review event for the specified worker. This endpoint is typically used by managers or administrators to submit time on behalf of workers, or by workers themselves to submit their own time for approval.\n\nSpecify these required fields in the request body:\n\n* date: the date that constructs the Time Review Event. The date is used to create Time Review Events for the Period or Week, depending on how that worker's Time Entry Template is configured.\n\nAdditional optional field:\n\n* comment: comment related to the business process that persists on each Time Review Event. Comments are not allowed if disabled on the Enter Time business process.\n\nTo get more information about Administrator-configured critical time validations, use the GET /timeValidations operation.\n\nThis operation is equivalent to the Submit Time task in the Workday UI. The same validations and business rules apply. This includes any configured approvals, notifications, and audit trails.\n\nSample Request:\n```\n{\n \"date\": \"2024-01-26\",\n \"comment\": \"Submitting time for approval.\"\n}\n```\n\nSecured By Domain: Manager: Time Tracking Manager Approval, Manager: Time Tracking Manager Edit and Approve\n\nSecured By Business Process Type: Enter Time\n\nScope: Time Tracking, Time Tracking Hub", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|me)$" }, { "in": "body", "name": "timeReviewEventContainerView", "required": true, "schema": { "$ref": "#/definitions/timeReviewEventContainerView_025a35898dab10000c71121b930a1715" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/timeReviewEventContainerView_025a35898dab10000c71121b930a1715" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A188 | You can't submit a comment because comments are disabled on this business process. |\n| Critical | A699 | Period Schedule does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A734 | Time Entry Template does not exist for the \\~worker\\~, [worker], as of [date]. |\n| Critical | A789 | [date] is locked for time entry for [worker]. |\n| Critical | A947 | Specify a date to Submit Time. |\n| Critical | A948 | No Time Blocks or Time Off to Submit exist in the period containing [date]. Enter Time in this period or specify a date that contains Time to Submit. |\n| Critical | A949 | The period containing [date] caused Critical Time validation errors. To see details about the errors, use the Enter Time Calendar task. |", "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": "025a35898dab10000be542924fda16bf", "x-workday-secured-by-domains": [ "Manager: Time Tracking Manager Approval", "Manager: Time Tracking Manager Edit and Approve" ], "x-workday-secured-by-business-process-types": [ "Enter Time" ] } }, "/timeClockEvents": { "get": { "tags": [ "timeClockEvents" ], "summary": "Retrieves a collection of time clock events for a worker for a date range.", "description": "Retrieves a collection of time clock events. You can filter by the time clock events by worker and date range.\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "name": "fromDate", "in": "query", "description": "The start date of the time event 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": "toDate", "in": "query", "description": "The end date of the time event using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker for the time block or clock event. You can specify multiple worker query parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/timeClockEventView_3e3738572cc010000fdfe310d0900010" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed on check-out. |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed on check-out. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed. |\n| Critical | A698 | Enter a dateTime. |\n| Critical | A702 | Enter a different eventType. [Punch Type] is not an allowed eventType. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed on check-out. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed. |\n| Critical | A705 | Enter an eventType. |\n| Critical | A707 | [Time Entry Code] is not an allowed timeEntryCode. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed by the time entry code. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed on check-out. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed on check-out. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed on check-out. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed. |\n| Critical | A715 | Remove project or projectPlanTask. The time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask because the time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask. ProjectPlanTask is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed on check-out. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed on check-out. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed on check-out. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed on check-out. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed. |\n| Critical | A730 | Remove region. Region is not allowed on check-out. |\n| Critical | A730 | Remove region. Region is not allowed. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed on check-out. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed. |\n| Critical | A740 | Remove location. Location is not allowed on check-out. |\n| Critical | A740 | Remove location. Location is not allowed. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed on check-out. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed. |\n| Critical | A743 | Remove project because the time entry template is not configured for project time entry. |\n| Critical | A743 | Remove project. Project is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed on check-out. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed. |\n| Critical | A749 | When you enter [project], these worktag types must also have a value: [worktags]. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed on check-out. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed. |\n| Critical | A752 | Enter either a timeEntryCode, project, or projectPlanTask. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled] |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed on check-out. |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed on check-out. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed on check-out. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed on check-out. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed on check-out. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed on check-out. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed. |\n| Critical | A773 | Remove fund. Fund is not allowed on check-out. |\n| Critical | A773 | Remove fund. Fund is not allowed. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed on check-out. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed. |\n| Critical | A777 | Remove grant. Grant is not allowed on check-out. |\n| Critical | A777 | Remove grant. Grant is not allowed. |\n| Critical | A780 | [Project] is not an allowed project. |\n| Critical | A782 | The position [position] is not valid for the worker on the date of the time clock event. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed on check-out. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed on check-out. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed on check-out. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed on check-out. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed. |\n| Critical | A794 | Enter a timeZone. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed on check-out. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed. |\n| Critical | A796 | The Following Worktags are required: [related_required_worktags] |\n| Critical | A797 | [Project Plan Task] is not an allowed projectPlanTask. |\n| Critical | A798 | Enter a worker. |\n| Critical | A803 | Remove gift. Gift is not allowed on check-out. |\n| Critical | A803 | Remove gift. Gift is not allowed. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed on check-out. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed. |\n| Critical | A813 | Remove timeEntryCode. TimeEntryCode is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed on check-out. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed on check-out. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed on check-out. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A3151 | You can't create or edit the time clock event for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "0ef1147a7c75100016d6b79db54a0012", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] }, "post": { "tags": [ "timeClockEvents" ], "summary": "Adds time clock events for the specified workers. This endpoint is used for both check in and check out.", "description": "Creates time clock event instances for the specified workers.\n\nIn the request body, specify at least these required fields: worker, eventType, dateTime, and timeZone.\n\nThe request cannot include more than one of these mutually exclusive fields: timeEntryCode, project, or projectPlanTask.\n\nWorker time attestations must be created before adding the time clock event, if applicable. For more information on Time Attestations, see Setup Considerations: Time Attestations in the Admin Guide.\n\nStarting with version v7 of the API, the dateTime and timeZone fields are structured in one block.\n\nSample Request Body:\nv1-v6:\n{\n ...\n \"dateTime\": \"2024-01-22T08:00:00.000\",\n \"timeZone\": {\n \"id\":\"dc10e1b4446c11de98360015c5e6daf6\"\n }\n ...\n}\n\nv7 onwards:\n{\n ...\n \"dateWithTimeZone\" : {\n \"dateTime\": \"2024-01-22T08:00:00.000\",\n \"timeZone\": \"dc10e1b4446c11de98360015c5e6daf6\"\n }\n ...\n}\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "timeClockEventView", "required": true, "schema": { "$ref": "#/definitions/timeClockEventView_3e3738572cc010000fdfe310d0900010" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/timeClockEventView_3e3738572cc010000fdfe310d0900010" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed on check-out. |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed. |\n| Critical | A695 | Enter a customOrganization04. A customOrganization04 is required by the time entry code. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed on check-out. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed. |\n| Critical | A697 | Enter a customWorktag13. A customWorktag13 is required by the time entry code. |\n| Critical | A698 | Enter a dateTime. |\n| Critical | A701 | Enter a customWorktag02. A customWorktag02 is required by the time entry code. |\n| Critical | A702 | Enter a different eventType. [Punch Type] is not an allowed eventType. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed on check-out. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed. |\n| Critical | A705 | Enter an eventType. |\n| Critical | A707 | [Time Entry Code] is not an allowed timeEntryCode. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed by the time entry code. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed on check-out. |\n| Critical | A710 | Enter a customWorktag01. A customWorktag01 is required by the time entry code. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed on check-out. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed. |\n| Critical | A712 | Enter a location. A location is required by the time entry code. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed on check-out. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed. |\n| Critical | A714 | Enter a customWorktag04. A customWorktag04 is required by the time entry code. |\n| Critical | A715 | Remove project or projectPlanTask. The time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask because the time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask. ProjectPlanTask is not allowed on check-out. |\n| Critical | A717 | Enter a customOrganization02. A customOrganization02 is required by the time entry code. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed. |\n| Critical | A722 | Enter a jobProfile. A jobProfile is required by the time entry code. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed on check-out. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed. |\n| Critical | A724 | Enter a customWorktag06. A customWorktag06 is required by the time entry code. |\n| Critical | A725 | Enter a costCenter. A costCenter is required by the time entry code. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed on check-out. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed on check-out. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed on check-out. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed. |\n| Critical | A730 | Remove region. Region is not allowed on check-out. |\n| Critical | A730 | Remove region. Region is not allowed. |\n| Critical | A731 | Enter a customOrganization05. A customOrganization05 is required by the time entry code. |\n| Critical | A732 | Enter a region. A region is required by the time entry code. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed on check-out. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed. |\n| Critical | A739 | Enter a gift. A gift is required by the time entry code. |\n| Critical | A740 | Remove location. Location is not allowed on check-out. |\n| Critical | A740 | Remove location. Location is not allowed. |\n| Critical | A741 | Enter a customOrganization07. A customOrganization07 is required by the time entry code. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed on check-out. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed. |\n| Critical | A743 | Remove project because the time entry template is not configured for project time entry. |\n| Critical | A743 | Remove project. Project is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed. |\n| Critical | A747 | Enter a customWorktag05. A customWorktag05 is required by the time entry code. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed on check-out. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed. |\n| Critical | A749 | When you enter [project], these worktag types must also have a value: [worktags]. |\n| Critical | A750 | Enter a grant. A grant is required by the time entry code. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed on check-out. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed. |\n| Critical | A752 | Enter either a timeEntryCode, project, or projectPlanTask. |\n| Critical | A753 | Enter a fund. A fund is required by the time entry code. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled] |\n| Critical | A755 | Enter a customWorktag08. A customWorktag08 is required by the time entry code. |\n| Critical | A757 | Enter a businessUnit. A businessUnit is required by the time entry code. |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed on check-out. |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed on check-out. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed on check-out. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed on check-out. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed on check-out. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed. |\n| Critical | A767 | Enter a customOrganization06. A customOrganization06 is required by the time entry code. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed on check-out. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed. |\n| Critical | A769 | Enter a customOrganization09. A customOrganization09 is required by the time entry code. |\n| Critical | A770 | Enter a customWorktag11. A customWorktag11 is required by the time entry code. |\n| Critical | A773 | Remove fund. Fund is not allowed on check-out. |\n| Critical | A773 | Remove fund. Fund is not allowed. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed on check-out. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed. |\n| Critical | A776 | Enter a customWorktag15. A customWorktag15 is required by the time entry code. |\n| Critical | A777 | Remove grant. Grant is not allowed on check-out. |\n| Critical | A777 | Remove grant. Grant is not allowed. |\n| Critical | A780 | [Project] is not an allowed project. |\n| Critical | A782 | The position [position] is not valid for the worker on the date of the time clock event. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed on check-out. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed on check-out. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed. |\n| Critical | A785 | Enter a customOrganization08. A customOrganization08 is required by the time entry code. |\n| Critical | A787 | Enter a position. Position is required for \\~workers\\~ with multiple positions. |\n| Critical | A788 | Enter a customWorktag03. A customWorktag03 is required by the time entry code. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed on check-out. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed. |\n| Critical | A791 | Enter a customWorktag07. A customWorktag07 is required by the time entry code. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed on check-out. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed. |\n| Critical | A794 | Enter a timeZone. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed on check-out. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed. |\n| Critical | A796 | The Following Worktags are required: [related_required_worktags] |\n| Critical | A797 | [Project Plan Task] is not an allowed projectPlanTask. |\n| Critical | A798 | Enter a worker. |\n| Critical | A799 | Enter a customWorktag10. A customWorktag10 is required by the time entry code. |\n| Critical | A802 | Enter a customWorktag12. A customWorktag12 is required by the time entry code. |\n| Critical | A803 | Remove gift. Gift is not allowed on check-out. |\n| Critical | A803 | Remove gift. Gift is not allowed. |\n| Critical | A804 | Enter a customOrganization01. A customOrganization01 is required by the time entry code. |\n| Critical | A805 | Enter a program. A program is required by the time entry code. |\n| Critical | A806 | Enter a customWorktag09. A customWorktag09 is required by the time entry code. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed on check-out. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed. |\n| Critical | A809 | Enter a customOrganization10. A customOrganization10 is required by the time entry code. |\n| Critical | A813 | Remove timeEntryCode. TimeEntryCode is not allowed on check-out. |\n| Critical | A814 | Enter a customOrganization03. A customOrganization03 is required by the time entry code. |\n| Critical | A815 | Remove position. Position is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A816 | Enter a customWorktag14. A customWorktag14 is required by the time entry code. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed on check-out. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed. |\n| Critical | A1261 | Enter an Appropriation. An Appropriation is required by the time entry code. |\n| Critical | A1262 | Enter an Allocation Pool. An Allocation Pool is required by the time entry code. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed on check-out. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed on check-out. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A1723 | Check in during your scheduled shift. You can’t check in more than [threshold_minutes] minutes before your shift or after it’s over. |\n| Critical | A1772 | Check in during your scheduled shift. For position [passed_position], you can’t check in more than [threshold_minutes] minutes before your shift or after it’s over. You also can't check in if you're not scheduled for this position. |\n| Critical | A2853 | These specified attestation prompts are for a different worker: [Worker Time Attestations]. |\n| Critical | A2854 | Don't specify followup worker time attestations: [followupWTAs]. Specify the parent Worker Time Attestation instead: [parent]. |\n| Critical | A2855 | These worker time attestations aren't valid for this time clock event: [WTA]. |\n| Critical | A2856 | You can't create the time clock event because a worker time attestation is required. Run the GET timeAttestationPrompts operation to retrieve a list of valid prompts to make the worker time attestations. |\n| Critical | A2857 | Remove the workerTimeAttestations field values. These attestations already have a parent time clock event: [Worker Time Attestations] |\n| Critical | A2858 | Specify a unique time attestation prompt for each worker time attestation. These worker time attestations are using duplicate time attestation prompts: [workerTimeAttestations]. |\n| Critical | A2859 | These worker time attestations are missing followup prompts: [Worker Time Attestations]. Run the GET followupTimeAttestationPrompt operation to retrieve the valid followup prompts for these time attestations. |\n| Critical | A2860 | It's too early to \\~check back in (time)\\~! You must take a full [time] minutes [meal_or_break]. |\n| Critical | A3151 | You can't create or edit the time clock event for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "0ef1147a7c75100016d6b3af44fc0011", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] } }, "/workerTimeAttestation/{ID}": { "get": { "tags": [ "workerTimeAttestation" ], "summary": "Retrieves a worker time attestation.", "description": "Retrieves a worker time attestation with the specified ID.\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "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/workerTimeAttestationView_1beff00ce821100020d7c3b93f4d0000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2822 | Specify a value for comment. |\n| Critical | A2823 | Specify a valid eventType for the Worker for the specified date. This eventType isn't valid: [eventType]. Run the GET /values/timeValues/outReason to retrieve valid event types. |\n| Critical | A2824 | Specify a response. |\n| Critical | A2826 | Specify a value for dateTime. |\n| Critical | A2827 | The specified value is for a followup time attestation prompt: [timeAttestationRulePrompt]. Specify either a parent time attestation prompt or use this followup attestation prompt with a followup worker time attestation. |\n| Critical | A2828 | Specify a timeAttestationPrompt. Run the GET TimeAttestationPrompt operation to retrieve the valid time attestation prompts. |\n| Critical | A2829 | Specify a value for eventType. |\n| Critical | A2830 | Specify a valid time attestation prompt. This time attestation prompt isn't valid for this combination of worker, eventType, dateTime, and timeZone. |\n| Critical | A2832 | Specify a valid response. This response isn't valid for this time attestation prompt: [timeAttestationPromptResponse]. |\n| Critical | A2833 | Specify a value for worker. Run the GET worker operation to retrieve valid worker names and IDs. |\n| Critical | A2834 | Specify a value for timeZone. |", "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": "1beff00ce82110002034d8b3ce600000", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] } }, "/values/timeValues/workerTimeZone/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "date", "in": "query", "description": "The effective date to look up time values for a given worker.", "required": false, "type": "string", "format": "date" }, { "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" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker to look up time values for.", "required": false, "type": "string" } ] }, "/workers/{ID}/timeTotals/{subresourceID}": { "get": { "tags": [ "workers" ], "summary": "Retrieves a summary of reported hours for a worker over a period.", "description": "Retrieves a summary of reported hours for a worker over a period. The period contains the specified date or, if not specified, it contains today's date.\n\nSecured By Domain: Process: Time Block REST APIs, Process: Time Clock Event REST API's\n\nScope: Time Tracking", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|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/periodTotalSummary_c649d8a6912a10000d519b738a2c0070" } }, "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": "177cde337c80100033390ff6f590001e", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs", "Process: Time Clock Event REST API's" ] } }, "/timeClockEvents/{ID}": { "get": { "tags": [ "timeClockEvents" ], "summary": "Retrieves a time clock event.", "description": "Retrieves a time clock event with the specified ID.\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "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: Time_Clock_Event_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Time_Clock_Event_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/timeClockEventView_3e3738572cc010000fdfe310d0900010" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed on check-out. |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed on check-out. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed. |\n| Critical | A698 | Enter a dateTime. |\n| Critical | A702 | Enter a different eventType. [Punch Type] is not an allowed eventType. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed on check-out. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed. |\n| Critical | A705 | Enter an eventType. |\n| Critical | A707 | [Time Entry Code] is not an allowed timeEntryCode. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed by the time entry code. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed on check-out. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed on check-out. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed on check-out. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed. |\n| Critical | A715 | Remove project or projectPlanTask. The time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask because the time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask. ProjectPlanTask is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed on check-out. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed on check-out. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed on check-out. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed on check-out. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed. |\n| Critical | A730 | Remove region. Region is not allowed on check-out. |\n| Critical | A730 | Remove region. Region is not allowed. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed on check-out. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed. |\n| Critical | A740 | Remove location. Location is not allowed on check-out. |\n| Critical | A740 | Remove location. Location is not allowed. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed on check-out. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed. |\n| Critical | A743 | Remove project because the time entry template is not configured for project time entry. |\n| Critical | A743 | Remove project. Project is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed on check-out. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed. |\n| Critical | A749 | When you enter [project], these worktag types must also have a value: [worktags]. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed on check-out. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed. |\n| Critical | A752 | Enter either a timeEntryCode, project, or projectPlanTask. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled] |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed on check-out. |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed on check-out. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed on check-out. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed on check-out. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed on check-out. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed on check-out. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed. |\n| Critical | A773 | Remove fund. Fund is not allowed on check-out. |\n| Critical | A773 | Remove fund. Fund is not allowed. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed on check-out. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed. |\n| Critical | A777 | Remove grant. Grant is not allowed on check-out. |\n| Critical | A777 | Remove grant. Grant is not allowed. |\n| Critical | A780 | [Project] is not an allowed project. |\n| Critical | A782 | The position [position] is not valid for the worker on the date of the time clock event. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed on check-out. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed on check-out. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed on check-out. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed on check-out. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed. |\n| Critical | A794 | Enter a timeZone. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed on check-out. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed. |\n| Critical | A796 | The Following Worktags are required: [related_required_worktags] |\n| Critical | A797 | [Project Plan Task] is not an allowed projectPlanTask. |\n| Critical | A798 | Enter a worker. |\n| Critical | A803 | Remove gift. Gift is not allowed on check-out. |\n| Critical | A803 | Remove gift. Gift is not allowed. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed on check-out. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed. |\n| Critical | A813 | Remove timeEntryCode. TimeEntryCode is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed on check-out. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed on check-out. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed on check-out. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A3151 | You can't create or edit the time clock event for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "0ef1147a7c75100016d6b79db54a0012", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] }, "put": { "tags": [ "timeClockEvents" ], "summary": "Updates the time clock event for the specified ID.", "description": "Updates the time clock event for the specified ID. Replaces the existing time clock event with the specified data in the request body.\n\nThe timeEntryCode, project, and projectPlanTask fields are mutually exclusive. You can only specify 1 of these fields in the request body.\n\nFor the timeEntryCode id, you can use a returned id from GET /values/timeTypes/timeEntryCodes, which returns the time entry codes that the given worker is eligible for on the given date. \n\nFor a valid project id, you can use a returned id from GET /values/timeTypes/projects, which you can filter by date and worker.\n\nFor a valid projectPlanTask id, you can use a returned id from GET /values/timeTypes/projectPlanTasks, which you can filter by date, worker, and project.\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "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: Time_Clock_Event_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Time_Clock_Event_ID)=\\S+)$" }, { "in": "body", "name": "timeClockEventView", "required": true, "schema": { "$ref": "#/definitions/timeClockEventView_3e3738572cc010000fdfe310d0900010" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/timeClockEventView_3e3738572cc010000fdfe310d0900010" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed on check-out. |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed. |\n| Critical | A694 | You cannot change a check-in event type into a check-out event type |\n| Critical | A695 | Enter a customOrganization04. A customOrganization04 is required by the time entry code. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed on check-out. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed. |\n| Critical | A697 | Enter a customWorktag13. A customWorktag13 is required by the time entry code. |\n| Critical | A698 | Enter a dateTime. |\n| Critical | A700 | Timezone cannot be edited in a put request. |\n| Critical | A701 | Enter a customWorktag02. A customWorktag02 is required by the time entry code. |\n| Critical | A702 | Enter a different eventType. [Punch Type] is not an allowed eventType. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed on check-out. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed. |\n| Critical | A705 | Enter an eventType. |\n| Critical | A707 | [Time Entry Code] is not an allowed timeEntryCode. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed by the time entry code. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed on check-out. |\n| Critical | A710 | Enter a customWorktag01. A customWorktag01 is required by the time entry code. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed on check-out. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed. |\n| Critical | A712 | Enter a location. A location is required by the time entry code. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed on check-out. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed. |\n| Critical | A714 | Enter a customWorktag04. A customWorktag04 is required by the time entry code. |\n| Critical | A715 | Remove project or projectPlanTask. The time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask because the time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask. ProjectPlanTask is not allowed on check-out. |\n| Critical | A717 | Enter a customOrganization02. A customOrganization02 is required by the time entry code. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed. |\n| Critical | A722 | Enter a jobProfile. A jobProfile is required by the time entry code. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed on check-out. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed. |\n| Critical | A724 | Enter a customWorktag06. A customWorktag06 is required by the time entry code. |\n| Critical | A725 | Enter a costCenter. A costCenter is required by the time entry code. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed on check-out. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed on check-out. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed on check-out. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed. |\n| Critical | A730 | Remove region. Region is not allowed on check-out. |\n| Critical | A730 | Remove region. Region is not allowed. |\n| Critical | A731 | Enter a customOrganization05. A customOrganization05 is required by the time entry code. |\n| Critical | A732 | Enter a region. A region is required by the time entry code. |\n| Critical | A735 | You cannot change a check-out event type into a check-in event type |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed on check-out. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed. |\n| Critical | A739 | Enter a gift. A gift is required by the time entry code. |\n| Critical | A740 | Remove location. Location is not allowed on check-out. |\n| Critical | A740 | Remove location. Location is not allowed. |\n| Critical | A741 | Enter a customOrganization07. A customOrganization07 is required by the time entry code. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed on check-out. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed. |\n| Critical | A743 | Remove project because the time entry template is not configured for project time entry. |\n| Critical | A743 | Remove project. Project is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed. |\n| Critical | A747 | Enter a customWorktag05. A customWorktag05 is required by the time entry code. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed on check-out. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed. |\n| Critical | A749 | When you enter [project], these worktag types must also have a value: [worktags]. |\n| Critical | A750 | Enter a grant. A grant is required by the time entry code. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed on check-out. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed. |\n| Critical | A752 | Enter either a timeEntryCode, project, or projectPlanTask. |\n| Critical | A753 | Enter a fund. A fund is required by the time entry code. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled] |\n| Critical | A755 | Enter a customWorktag08. A customWorktag08 is required by the time entry code. |\n| Critical | A756 | Worker is not editable |\n| Critical | A757 | Enter a businessUnit. A businessUnit is required by the time entry code. |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed on check-out. |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed on check-out. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed. |\n| Critical | A762 | You cannot edit the datetime field as a self-service worker. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed on check-out. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed on check-out. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed on check-out. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed. |\n| Critical | A767 | Enter a customOrganization06. A customOrganization06 is required by the time entry code. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed on check-out. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed. |\n| Critical | A769 | Enter a customOrganization09. A customOrganization09 is required by the time entry code. |\n| Critical | A770 | Enter a customWorktag11. A customWorktag11 is required by the time entry code. |\n| Critical | A773 | Remove fund. Fund is not allowed on check-out. |\n| Critical | A773 | Remove fund. Fund is not allowed. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed on check-out. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed. |\n| Critical | A775 | The In time for a matched time clock event must be before the Out time of [time] |\n| Critical | A776 | Enter a customWorktag15. A customWorktag15 is required by the time entry code. |\n| Critical | A777 | Remove grant. Grant is not allowed on check-out. |\n| Critical | A777 | Remove grant. Grant is not allowed. |\n| Critical | A779 | Reference ID is not editable |\n| Critical | A780 | [Project] is not an allowed project. |\n| Critical | A782 | The position [position] is not valid for the worker on the date of the time clock event. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed on check-out. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed on check-out. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed. |\n| Critical | A785 | Enter a customOrganization08. A customOrganization08 is required by the time entry code. |\n| Critical | A787 | Enter a position. Position is required for \\~workers\\~ with multiple positions. |\n| Critical | A788 | Enter a customWorktag03. A customWorktag03 is required by the time entry code. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed on check-out. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed. |\n| Critical | A791 | Enter a customWorktag07. A customWorktag07 is required by the time entry code. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed on check-out. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed. |\n| Critical | A793 | You cannot edit a matched time clock event in a locked period |\n| Critical | A794 | Enter a timeZone. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed on check-out. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed. |\n| Critical | A796 | The Following Worktags are required: [related_required_worktags] |\n| Critical | A797 | [Project Plan Task] is not an allowed projectPlanTask. |\n| Critical | A798 | Enter a worker. |\n| Critical | A799 | Enter a customWorktag10. A customWorktag10 is required by the time entry code. |\n| Critical | A802 | Enter a customWorktag12. A customWorktag12 is required by the time entry code. |\n| Critical | A803 | Remove gift. Gift is not allowed on check-out. |\n| Critical | A803 | Remove gift. Gift is not allowed. |\n| Critical | A804 | Enter a customOrganization01. A customOrganization01 is required by the time entry code. |\n| Critical | A805 | Enter a program. A program is required by the time entry code. |\n| Critical | A806 | Enter a customWorktag09. A customWorktag09 is required by the time entry code. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed on check-out. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed. |\n| Critical | A809 | Enter a customOrganization10. A customOrganization10 is required by the time entry code. |\n| Critical | A810 | The Out time for a matched time clock event must be after the In time of [time] |\n| Critical | A813 | Remove timeEntryCode. TimeEntryCode is not allowed on check-out. |\n| Critical | A814 | Enter a customOrganization03. A customOrganization03 is required by the time entry code. |\n| Critical | A815 | Remove position. Position is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A816 | Enter a customWorktag14. A customWorktag14 is required by the time entry code. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed on check-out. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed. |\n| Critical | A1261 | Enter an Appropriation. An Appropriation is required by the time entry code. |\n| Critical | A1262 | Enter an Allocation Pool. An Allocation Pool is required by the time entry code. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed on check-out. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed on check-out. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A2852 | You can't edit the worker time attestation field on a time clock event. |\n| Critical | A3074 | You can't edit the time clock event for [worker] on [date] because you don't have access to this time entry code: [time entry code] |\n| Critical | A3151 | You can't create or edit the time clock event for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "aff05900fbd9100010cc0fb01b9a0027", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] }, "delete": { "tags": [ "timeClockEvents" ], "summary": "Deletes a time clock event.", "description": "Deletes a time clock event with the specified ID.\n\nSecured By Domain: Process: Delete Time Clock Event REST API's\n\nScope: Time Tracking", "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: Time_Clock_Event_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Time_Clock_Event_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 | A693 | Remove customOrganization07. CustomOrganization07 is not allowed on check-out. |\n| Critical | A693 | Remove customOrganization07. CustomOrganization07 is not allowed. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed on check-out. |\n| Critical | A696 | Remove customWorktag15. CustomWorktag15 is not allowed. |\n| Critical | A698 | Enter a dateTime. |\n| Critical | A702 | Enter a different eventType. [Punch Type] is not an allowed eventType. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed on check-out. |\n| Critical | A703 | Remove customOrganization02. CustomOrganization02 is not allowed. |\n| Critical | A705 | Enter an eventType. |\n| Critical | A707 | [Time Entry Code] is not an allowed timeEntryCode. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed by the time entry code. |\n| Critical | A708 | Remove overrideRate. OverrideRate is not allowed on check-out. |\n| Critical | A709 | Time Clock Event cannot be deleted. Cannot delete a matched Time Clock Event in a locked period. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed on check-out. |\n| Critical | A711 | Remove customWorktag03. CustomWorktag03 is not allowed. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed on check-out. |\n| Critical | A713 | Remove customWorktag10. CustomWorktag10 is not allowed. |\n| Critical | A715 | Remove project or projectPlanTask. The time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask because the time entry template is not configured for project time entry. |\n| Critical | A716 | Remove projectPlanTask. ProjectPlanTask is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed on check-out. |\n| Critical | A721 | Remove costCenter. CostCenter is not allowed. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed on check-out. |\n| Critical | A723 | Remove customWorktag13. CustomWorktag13 is not allowed. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed on check-out. |\n| Critical | A727 | Remove customOrganization01. CustomOrganization01 is not allowed. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed on check-out. |\n| Critical | A728 | Remove customWorktag12. CustomWorktag12 is not allowed. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed on check-out. |\n| Critical | A729 | Remove customOrganization10. CustomOrganization10 is not allowed. |\n| Critical | A730 | Remove region. Region is not allowed on check-out. |\n| Critical | A730 | Remove region. Region is not allowed. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed on check-out. |\n| Critical | A738 | Remove customOrganization05. CustomOrganization05 is not allowed. |\n| Critical | A740 | Remove location. Location is not allowed on check-out. |\n| Critical | A740 | Remove location. Location is not allowed. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed on check-out. |\n| Critical | A742 | Remove businessUnit. BusinessUnit is not allowed. |\n| Critical | A743 | Remove project because the time entry template is not configured for project time entry. |\n| Critical | A743 | Remove project. Project is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed on check-out. |\n| Critical | A746 | Remove program. Program is not allowed. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed on check-out. |\n| Critical | A748 | Remove customOrganization04. CustomOrganization04 is not allowed. |\n| Critical | A749 | When you enter [project], these worktag types must also have a value: [worktags]. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed on check-out. |\n| Critical | A751 | Remove customWorktag05. CustomWorktag05 is not allowed. |\n| Critical | A752 | Enter either a timeEntryCode, project, or projectPlanTask. |\n| Critical | A754 | The following worktags are not enabled for self-service edit in worker's time entry template: [worktags not enabled] |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed on check-out. |\n| Critical | A760 | Remove customWorktag07. CustomWorktag07 is not allowed. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed on check-out. |\n| Critical | A761 | Remove customOrganization08. CustomOrganization08 is not allowed. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed on check-out. |\n| Critical | A763 | Remove customOrganization09. CustomOrganization09 is not allowed. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed on check-out. |\n| Critical | A764 | Remove customWorktag09. CustomWorktag09 is not allowed. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed on check-out. |\n| Critical | A766 | Remove customWorktag01. CustomWorktag01 is not allowed. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed on check-out. |\n| Critical | A768 | Remove customWorktag02. CustomWorktag02 is not allowed. |\n| Critical | A773 | Remove fund. Fund is not allowed on check-out. |\n| Critical | A773 | Remove fund. Fund is not allowed. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed on check-out. |\n| Critical | A774 | Remove customWorktag08. CustomWorktag08 is not allowed. |\n| Critical | A777 | Remove grant. Grant is not allowed on check-out. |\n| Critical | A777 | Remove grant. Grant is not allowed. |\n| Critical | A780 | [Project] is not an allowed project. |\n| Critical | A782 | The position [position] is not valid for the worker on the date of the time clock event. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed on check-out. |\n| Critical | A783 | Remove jobProfile. JobProfile is not allowed. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed on check-out. |\n| Critical | A784 | Remove customOrganization03. CustomOrganization03 is not allowed. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed on check-out. |\n| Critical | A790 | Remove customOrganization06. CustomOrganization06 is not allowed. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed on check-out. |\n| Critical | A792 | Remove customWorktag04. CustomWorktag04 is not allowed. |\n| Critical | A794 | Enter a timeZone. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed on check-out. |\n| Critical | A795 | Remove customWorktag06. CustomWorktag06 is not allowed. |\n| Critical | A796 | The Following Worktags are required: [related_required_worktags] |\n| Critical | A797 | [Project Plan Task] is not an allowed projectPlanTask. |\n| Critical | A798 | Enter a worker. |\n| Critical | A803 | Remove gift. Gift is not allowed on check-out. |\n| Critical | A803 | Remove gift. Gift is not allowed. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed on check-out. |\n| Critical | A807 | Remove customWorktag14. CustomWorktag14 is not allowed. |\n| Critical | A813 | Remove timeEntryCode. TimeEntryCode is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not allowed on check-out. |\n| Critical | A815 | Remove position. Position is not required for \\~Workers\\~ with a single position. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed on check-out. |\n| Critical | A817 | Remove customWorktag11. CustomWorktag11 is not allowed. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed on check-out. |\n| Critical | A1263 | Remove Appropriation. Appropriation is not allowed. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed on check-out. |\n| Critical | A1264 | Remove Allocation Pool. Allocation Pool is not allowed. |\n| Critical | A2773 | You can't delete the time clock event for this worker on [date] because it's associated with a billable transaction that's currently locked: [worker]. |\n| Critical | A3021 | You can't delete the time clock event for [worker] on [date] because you don't have access to this time entry code: [time entry code]. |\n| Critical | A3151 | You can't create or edit the time clock event for [worker] on [date] because you don't have access to this time entry code: [time entry code from request]. |", "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": "16fdc804bf94100003ceec7bf8b80013", "x-workday-secured-by-domains": [ "Process: Delete Time Clock Event REST API's" ] } }, "/values/timeTypes/projectPlanTasks/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "date", "in": "query", "description": "The effective date to look up time types for a given worker.", "required": false, "type": "string", "format": "date" }, { "name": "inOutCodeOnly", "in": "query", "description": "If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event.", "required": false, "type": "boolean" }, { "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": "project", "in": "query", "description": "The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project.", "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" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker to look up time types for.", "required": false, "type": "string" } ] }, "/workers/{ID}/period": { "get": { "tags": [ "workers" ], "summary": "Retrieves a period from the period schedule the worker is eligible for.", "description": "Returns the period from the period schedule the worker is eligible for, on the given date. If you don't specify a date, today's date is used. This endpoint returns only 1 period.\n\nSecured By Domain: Process: Time Tracking Configuration Objects REST APIs\n\nScope: Time Tracking", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|me)$" }, { "name": "date", "in": "query", "description": "The date on which the worker is eligible, using the yyyy-mm-dd format. If date isn't given it will default to the current Date.", "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" } ], "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/periodView_4662da832dbb1000155d8cf48eda0138" } } } } }, "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": "8a858e8c5f6c1000267a7fcb7ecd044f", "x-workday-secured-by-domains": [ "Process: Time Tracking Configuration Objects REST APIs" ] } }, "/values/timeTypes/projects/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "date", "in": "query", "description": "The effective date to look up time types for a given worker.", "required": false, "type": "string", "format": "date" }, { "name": "inOutCodeOnly", "in": "query", "description": "If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event.", "required": false, "type": "boolean" }, { "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": "project", "in": "query", "description": "The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project.", "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" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker to look up time types for.", "required": false, "type": "string" } ] }, "/workers/{ID}": { "get": { "tags": [ "workers" ], "summary": "Retrieves a collection of workers and current staffing information.", "description": "Retrieves a collection of workers and current staffing information.\n\nSecured By Domain: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports\n\nScope: Staffing", "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: Employee_ID, Contingent_Worker_ID\n- **Named entry**: Valid values: `me`.", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Employee_ID|Contingent_Worker_ID)=\\S+|me)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/workerData_c2466b0778c610000d1936006720000e" } }, "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": "c2466b0778c610000cdf9abc4fbc000c", "x-workday-secured-by-domains": [ "FLW Service", "Self-Service: Current Staffing Information", "Worker Data: Public Worker Reports" ] } }, "/workerTimeAttestation/{ID}/followupTimeAttestationPrompt": { "get": { "tags": [ "workerTimeAttestation" ], "description": "\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/followupTimeAttestationPrompt_b70ff6bf8e65100011b4fb9f569e0000" } } } } }, "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": "b70ff6bf8e65100010ff760ab48e0000", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] } }, "/values/timeValues/outReason/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "date", "in": "query", "description": "The effective date to look up time values for a given worker.", "required": false, "type": "string", "format": "date" }, { "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" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker to look up time values for.", "required": false, "type": "string" } ] }, "/workerTimeBlocks": { "get": { "tags": [ "workerTimeBlocks" ], "summary": "Retrieves time blocks for specified workers over a date range.", "description": "Retrieves time blocks for specified workers over a date range. This method does not return incomplete time blocks, time offs, and overtime request blocks.\n\nSecured By Domain: Process: Time Block REST APIs\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "name": "fromDate", "in": "query", "description": "The start date of the time block date range, 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": "phase", "in": "query", "description": "The Workday ID of the project plan phase for the time block.\nYou can specify 1 or more project plan phase query parameters. \nYou can use a returned id from the GET /planPhases endpoint in the Projects REST web service.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "project", "in": "query", "description": "The Workday ID of the project for the time block.\nYou can specify 1 or more project query parameters.\nYou can use a returned id from the GET /projects endpoint in the Projects REST web service.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "projectPlanTask", "in": "query", "description": "The Workday ID of the project plan task for the time block.\nYou can specify 1 or more project plan task query parameters.\nYou can use a returned id from the GET /planTasks endpoint in the Projects REST web service.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "status", "in": "query", "description": "The Workday ID of the approval status of the worker time block. Valid IDs are:\n\n* Submitted: dd817fe688db4ac7bf84e3ef79f72948\n\n* Unsubmitted (Not Submitted): ddf5968e6d4430ca4bce9a4cfaba337\n\n* Approved: 0391102bd1b542538d996936c8fa2fa7\n\n* Denied: 8fee8e9d07554b968bb1f19e679e5a05\n\n* Sent Back: 070b249867f747a19bca64f73eafc9b8\n\nYou can specify 1 or more status query parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "toDate", "in": "query", "description": "The end date of the time block date range, using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker for the time block. Specify workers that the user has permission to access.\nYou can specify 1 or more worker query parameters.\nYou can use returned ids from GET /workers.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/timeBlockView_18442114504f100016031395a48200ee" } } } } }, "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": "c56c2303fe6b1000116402a0024f00ea", "x-workday-secured-by-domains": [ "Process: Time Block REST APIs" ] } }, "/timeAttestationPrompts": { "get": { "tags": [ "timeAttestationPrompts" ], "summary": "Retrieves a collection of time attestation prompts for a time clock event.", "description": "Retrieves a collection of time attestation prompts. These are the prompts workers need to answer for a time clock event.\n\nSecured By Domain: Process: Time Clock Event REST API's\n\nScope: Time Tracking", "produces": [ "application/json" ], "parameters": [ { "name": "dateTime", "in": "query", "description": "The date and time of the simulated time clock event using the yyyy-mm-ddThh:mm:ss.sss format.", "required": false, "type": "string", "format": "date" }, { "name": "eventType", "in": "query", "description": "The Workday ID of the event type for the simulated time clock event.", "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": "timeZone", "in": "query", "description": "The Workday ID of the time zone for the simulated time clock event.", "required": false, "type": "string" }, { "name": "worker", "in": "query", "description": "The Workday ID of the worker for the simulated time clock event.", "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/timeAttestationPromptView_6f40500c8ed010001f549d43b4360000" } } } } }, "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": "6f40500c8ed010001f59e1a4d1b30000", "x-workday-secured-by-domains": [ "Process: Time Clock Event REST API's" ] } } }, "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" } } } }, "timeValidationView_76581637ef2410001ded866e9111001a": { "allOf": [ { "type": "object", "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": "The warning validation messages separated by the line feed character (hex code in JSON). The validation messages indicate that the requested objects fail the configured warning custom validations.", "x-workday-type": "Text" }, "criticalValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The critical validation messages separated by the line feed character (hex code in JSON). The validation messages indicate that the requested objects fail the configured critical custom validations.", "x-workday-type": "Text" } } } ] }, "prompt_e6141de0347810001d1811a31ccb0003": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The time attestation prompt for the worker time attestation." }, "response_e6141de0347810001d1811a31ccb0004": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The time attestation response for the worker time attestation." }, "timeZone_0fe5abcf809e10001509c0636e1a0000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The time zone for the simulated time clock event." }, "worker_e6141de0347810001d18110972020000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker for the simulated time clock event." }, "eventType_0fe5abcf809e100014bc35ea8de80000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The event type for the simulated time clock event." }, "workerTimeAttestationCreate_e6141de0347810001cba9a2683240000": { "allOf": [ { "type": "object", "properties": { "prompt": { "$ref": "#/definitions/prompt_e6141de0347810001d1811a31ccb0003" }, "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 for the worker time attestation.", "x-workday-type": "Text" }, "response": { "$ref": "#/definitions/response_e6141de0347810001d1811a31ccb0004" }, "needsFollowup": { "type": "boolean", "example": true, "description": "The response for the worker time attestation has a followup time attestation prompt that needs to be answered. The respose will be ignored in the request.", "x-workday-type": "Boolean" }, "order": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The order for the worker time attestation. The order will be ignored in the request.", "x-workday-type": "Text" }, "timeZone": { "$ref": "#/definitions/timeZone_0fe5abcf809e10001509c0636e1a0000" }, "dateTime": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date time for the simulated time clock event.", "x-workday-type": "Date" }, "worker": { "$ref": "#/definitions/worker_e6141de0347810001d18110972020000" }, "eventType": { "$ref": "#/definitions/eventType_0fe5abcf809e100014bc35ea8de80000" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Worker Time Attestation" } } } ] }, "WorkdayId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Workday ID (32-character lowercase hexadecimal string).", "example": "a3f5b554007d20e98360015c5e6daf6" }, "ResourceIdPathValue_workerTimeAttestation": {}, "prompt_1beff00ce8211000244fdb47323c0001": { "allOf": [ { "$ref": "#/definitions/timeAttestationPromptBasic_9749cd465123100025067f2b5c6c0000" }, {} ], "description": "The time attestation prompt for the worker time attestation." }, "response_1beff00ce8211000244fdb47323c0000": { "allOf": [ { "$ref": "#/definitions/timeAttestationResponseBasic_9749cd465123100025117a3a984c0000" }, {} ], "description": "The time attestation response for the worker time attestation." }, "timeClockEvent_0bea63fc1e5d10001dac6610e7ad0000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The time clock event for the worker time attestation." }, "worker_1beff00ce8211000244fdb47323c0004": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker for the simulated time clock event." }, "parentWorkerTimeAttestation_528b4ef236d2100026997ea6018b0001": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The parent worker time attestation for the worker time attestation." }, "followupWorkerTimeAttestation_528b4ef236d2100026997ea6018b0002": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The followup worker time attestation for the worker time attestation." }, "workerTimeAttestationView_1beff00ce821100020d7c3b93f4d0000": { "allOf": [ { "type": "object", "properties": { "prompt": { "$ref": "#/definitions/prompt_1beff00ce8211000244fdb47323c0001" }, "response": { "$ref": "#/definitions/response_1beff00ce8211000244fdb47323c0000" }, "timeClockEvent": { "$ref": "#/definitions/timeClockEvent_0bea63fc1e5d10001dac6610e7ad0000" }, "worker": { "$ref": "#/definitions/worker_1beff00ce8211000244fdb47323c0004" }, "needsFollowup": { "type": "boolean", "example": true, "description": "The worker's time attestation response has a followup time attestation prompt that needs to be answered.", "x-workday-type": "Boolean" }, "order": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The order of the worker time attestation.", "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 comment for the worker time attestation.", "x-workday-type": "Text" }, "parentWorkerTimeAttestation": { "$ref": "#/definitions/parentWorkerTimeAttestation_528b4ef236d2100026997ea6018b0001" }, "followupWorkerTimeAttestation": { "$ref": "#/definitions/followupWorkerTimeAttestation_528b4ef236d2100026997ea6018b0002" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Worker Time Attestation" } } } ] }, "followupTimeAttestationPrompt_b70ff6bf8e65100011b4fb9f569e0000": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "example": true, "description": "The followup time attestation prompt is required to be answered for the time clock event.", "x-workday-type": "Boolean" }, "requiresComment": { "type": "boolean", "example": true, "description": "A comment is required when creating the worker time attestation for the followup time attestation prompt.", "x-workday-type": "Boolean" }, "responses": { "type": "array", "description": "Time time attestation responses for the followup time attestation prompt.", "items": { "$ref": "#/definitions/responses_b70ff6bf8e65100011b4fc3912470002" }, "x-workday-type": "Multi-instance" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Attestation Rule Prompt" } } } ] }, "NamedEntry_workers": { "type": "string", "description": "Named entry alias", "enum": [ "me" ] }, "WorkdayReferenceId_workers": { "type": "string", "pattern": "^(Employee_ID|Contingent_Worker_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Employee_ID, Contingent_Worker_ID", "example": "Employee_ID=21002" }, "ResourceIdPathValue_workers": {}, "workerType_3f78eeedc01d1000138d97d80e5a0000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Retrieves the employee type or contingent worker type for the worker." }, "primaryJob_352c3a97ecd51000353cba144c5b0042": { "allOf": [ { "$ref": "#/definitions/jobDataForWorker_b8ac205877fd10000ea91719a02a00a2" }, {} ], "description": "The worker's primary job." }, "person_0ad147648b0a1000237bd486634a001a": { "allOf": [ { "$ref": "#/definitions/personDataView_be343791f59d100028d6a277ca8a0017" }, {} ], "description": "Person for the Worker" }, "workerData_c2466b0778c610000d1936006720000e": { "allOf": [ { "type": "object", "properties": { "additionalJobs": { "type": "array", "description": "The employee’s additional jobs and international assignments.", "items": { "$ref": "#/definitions/additionalJobs_352c3a97ecd51000353cba4ccc1c0043" }, "x-workday-type": "Multi-instance" }, "workerType": { "$ref": "#/definitions/workerType_3f78eeedc01d1000138d97d80e5a0000" }, "primaryJob": { "$ref": "#/definitions/primaryJob_352c3a97ecd51000353cba144c5b0042" }, "person": { "$ref": "#/definitions/person_0ad147648b0a1000237bd486634a001a" }, "workerId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Employee ID or Contingent Worker ID for the worker.", "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 Worker" } } } ] }, "periodView_4662da832dbb1000155d8cf48eda0138": { "allOf": [ { "type": "object", "properties": { "unlockTimeEntry": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date and time when the period is unlocked for time adjustments.", "x-workday-type": "Date" }, "openTimeEntry": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date and time when the period is open for time entry.", "x-workday-type": "Date" }, "periodEndDate": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The end date of the payroll period or the absence subperiod.", "x-workday-type": "Date" }, "periodStartDate": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The start date of the payroll period or the absence subperiod.", "x-workday-type": "Date" }, "paymentDate": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The payment date for periods whose period schedule's usage includes Payroll or Time Tracking without Payroll.", "x-workday-type": "Date" }, "lockTimeEntry": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date and time when the period becomes locked out.", "x-workday-type": "Date" }, "closeTimeEntry": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date and time when the period is closed for time entry.", "x-workday-type": "Date" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "ResourceIdPathValue_timeTotals": {}, "periodTotalSummary_c649d8a6912a10000d519b738a2c0070": { "allOf": [ { "type": "object", "properties": { "submitText": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Contains legal text the user must agree to in order to submit hours for review.", "x-workday-type": "Rich Text" }, "certifyText": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Contains legal text the user must agree to in order to certify hours worked.", "x-workday-type": "Rich Text" }, "totals": { "type": "array", "description": "List of all Totals defined in Time Entry Template", "items": { "$ref": "#/definitions/timeTotal_c649d8a6912a10000f116cb2a7f800a8" }, "x-workday-type": "Multi-instance" }, "periodLabel": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Contains the summary of the date range and total reported hours of a period.", "x-workday-type": "Text" } } } ] }, "timeReviewEventContainerView_025a35898dab10000c71121b930a1715": { "allOf": [ { "type": "object", "properties": { "date": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date used to create the time review event. The date uses the format: yyyy-mm-dd. If Submit by Time Period is enabled on the worker's Time Entry Template as of the provided date, time is submitted for the pay period. Otherwise, time is submitted for the week.", "x-workday-type": "Date" }, "timeReviewEvents": { "type": "array", "description": "Contains Time Review Events created in the Submit Time request.", "items": { "$ref": "#/definitions/timeReviewEvents_025a35898dab10000cce202b890c1722" }, "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 comment that persists on each time review event. Comments are not allowed if comments are disabled for the Enter Time business process or for all business processes in the tenant. For more information, see Reference: Edit Tenant Setup - Business Processes in the Admin Guide.", "x-workday-type": "Text" } } } ] }, "customWorktag07_69de94c991fe1000218b145195fa0452": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 07 for a reported time block." }, "customWorktag01_69de94c991fe100020d8f601a6800447": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 01 for a reported time block." }, "customWorktag13_69de94c991fe1000218b13c4f6cb044c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 13 for a reported time block." }, "customWorktag15_69de94c991fe1000218b1372e4fb044a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 15 for a reported time block." }, "customWorktag08_69de94c991fe1000218b144ce7160451": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 08 for a reported time block." }, "customWorktag14_69de94c991fe1000218b137d61f1044b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 14 for a reported time block." }, "customWorktag02_69de94c991fe1000218b14c468760457": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 02 for a reported time block." }, "customWorktag04_69de94c991fe1000218b14b56ea20455": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 04 for a reported time block." }, "customWorktag09_69de94c991fe1000218b142ff3440450": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 09 for a reported time block." }, "customWorktag06_69de94c991fe1000218b146aa96a0453": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 06 for a reported time block." }, "customWorktag05_69de94c991fe1000218b14ae4c530454": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 05 for a reported time block." }, "customWorktag03_69de94c991fe1000218b14bcb3670456": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 03 for a reported time block." }, "customWorktag10_69de94c991fe1000218b142b6e5e044f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 10 for a reported time block." }, "customWorktag11_69de94c991fe1000218b140c742d044e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 11 for a reported time block." }, "customWorktag12_69de94c991fe1000218b13eee03c044d": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 12 for a reported time block." }, "customOrganization10_622057fb770910001ec17d84cae0056e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 10 for a reported time block." }, "customOrganization06_622057fb770910001ec17da4d8430572": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 06 for a reported time block." }, "appropriation_8bff2c54c11e10000df4b86e6cd60000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The appropriation as worktag for a reported time block." }, "allocationPool_8bff2c54c11e10000df4b86e6cd60001": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The allocation pool as worktag for a reported time block." }, "customOrganization02_622057fb770910001ec17dbe66b00576": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 02 for a reported time block." }, "customOrganization03_622057fb770910001ec17db1e6090575": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 03 for a reported time block." }, "customOrganization04_622057fb770910001ec17dad8d500574": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 04 for a reported time block." }, "customOrganization05_622057fb770910001ec17da91e2d0573": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 05 for a reported time block." }, "customOrganization01_622057fb770910001e778f7cdc61053c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 01 for a reported time block." }, "customOrganization07_622057fb770910001ec17da069440571": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 07 for a reported time block." }, "customOrganization08_622057fb770910001ec17d95a3a80570": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 08 for a reported time block." }, "customOrganization09_622057fb770910001ec17d90ad01056f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 09 for a reported time block." }, "program_2c59cbf40d35100016cc7c5fce03022c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The program as worktag for a reported time block." }, "jobProfile_2c59cbf40d351000167c1db1aabc0227": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The job profile as worktag for a reported time block." }, "costCenter_2c59cbf40d3510001606811b605e0217": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The cost center as worktag for a reported time block." }, "location_2c59cbf40d35100016cc7c6d9f47022d": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The location as worktag for a reported time block." }, "grant_2c59cbf40d351000165fee6359770223": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The grant as worktag for a reported time block." }, "businessUnit_2c59cbf40d3510001316b415768e0207": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The business unit as worktag for a reported time block." }, "position_ca1fbf87fc9910000b3bdb0f333f0108": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker's position for a reported time block." }, "region_2c59cbf40d35100016cc7c5318a1022b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The region as worktag for a reported time block." }, "fund_2c59cbf40d351000162afefff76e021b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The fund as worktag for a reported time block." }, "gift_2c59cbf40d35100016462a876d4a021f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The gift as worktag for a reported time block." }, "status_18442114504f100026d30c1460a50112": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The status of the reported time block." }, "unit_18442114504f100026d30c2a38830114": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The unit for a reported time block." }, "worker_18442114504f10001e10e2282255010a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker for a reported time block." }, "timeEntryCode_18442114504f100025df72b5b8260110": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The time entry code for a reported time block." }, "projectRole_70b4c28387c3100012a4547f2bb74d82": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The project role for a reported time block." }, "projectPlanPhase_7253d97923c710000914ca2463350030": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "\\~Project Plan Phase\\~ for the Billable Transactions. REST API Internal Use Only.", "x-readOnly": true }, "inTimeZone_d35ad574d80a10001a4eb54b4f670751": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The in time zone for a reported time block." }, "outTimeZone_7250c62af41110001d4f4f6c58892419": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The out time zone for a reported time block." }, "outReason_5bebcdab469a1000249e2afbf6e7028f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The out reason for a reported time block." }, "project_8b25b2910fad100013106a9a0c950437": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The project for a reported time block." }, "projectPlanTask_8b25b2910fad100013106a8d2cbc0436": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The project plan task for a reported time block." }, "currency_622057fb7709100017b60484df4b03a4": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency for a reported time block." }, "timeBlockView_18442114504f100016031395a48200ee": { "allOf": [ { "type": "object", "properties": { "customWorktag07": { "$ref": "#/definitions/customWorktag07_69de94c991fe1000218b145195fa0452" }, "customWorktag01": { "$ref": "#/definitions/customWorktag01_69de94c991fe100020d8f601a6800447" }, "customWorktag13": { "$ref": "#/definitions/customWorktag13_69de94c991fe1000218b13c4f6cb044c" }, "customWorktag15": { "$ref": "#/definitions/customWorktag15_69de94c991fe1000218b1372e4fb044a" }, "customWorktag08": { "$ref": "#/definitions/customWorktag08_69de94c991fe1000218b144ce7160451" }, "customWorktag14": { "$ref": "#/definitions/customWorktag14_69de94c991fe1000218b137d61f1044b" }, "customWorktag02": { "$ref": "#/definitions/customWorktag02_69de94c991fe1000218b14c468760457" }, "customWorktag04": { "$ref": "#/definitions/customWorktag04_69de94c991fe1000218b14b56ea20455" }, "customWorktag09": { "$ref": "#/definitions/customWorktag09_69de94c991fe1000218b142ff3440450" }, "customWorktag06": { "$ref": "#/definitions/customWorktag06_69de94c991fe1000218b146aa96a0453" }, "customWorktag05": { "$ref": "#/definitions/customWorktag05_69de94c991fe1000218b14ae4c530454" }, "customWorktag03": { "$ref": "#/definitions/customWorktag03_69de94c991fe1000218b14bcb3670456" }, "customWorktag10": { "$ref": "#/definitions/customWorktag10_69de94c991fe1000218b142b6e5e044f" }, "customWorktag11": { "$ref": "#/definitions/customWorktag11_69de94c991fe1000218b140c742d044e" }, "customWorktag12": { "$ref": "#/definitions/customWorktag12_69de94c991fe1000218b13eee03c044d" }, "calculatedTimeDetails": { "type": "array", "description": "Returns all calculated time for this block.", "readOnly": true, "items": { "$ref": "#/definitions/calculatedTimeDetails_4a93e2d0dc73100013126e99abfd02b9" }, "x-workday-type": "Multi-instance" }, "outTime": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The out time for a reported time block.", "x-workday-type": "Date" }, "inTime": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The in time for a reported time block.", "x-workday-type": "Date" }, "customOrganization10": { "$ref": "#/definitions/customOrganization10_622057fb770910001ec17d84cae0056e" }, "customOrganization06": { "$ref": "#/definitions/customOrganization06_622057fb770910001ec17da4d8430572" }, "appropriation": { "$ref": "#/definitions/appropriation_8bff2c54c11e10000df4b86e6cd60000" }, "allocationPool": { "$ref": "#/definitions/allocationPool_8bff2c54c11e10000df4b86e6cd60001" }, "customOrganization02": { "$ref": "#/definitions/customOrganization02_622057fb770910001ec17dbe66b00576" }, "customOrganization03": { "$ref": "#/definitions/customOrganization03_622057fb770910001ec17db1e6090575" }, "customOrganization04": { "$ref": "#/definitions/customOrganization04_622057fb770910001ec17dad8d500574" }, "customOrganization05": { "$ref": "#/definitions/customOrganization05_622057fb770910001ec17da91e2d0573" }, "customOrganization01": { "$ref": "#/definitions/customOrganization01_622057fb770910001e778f7cdc61053c" }, "customOrganization07": { "$ref": "#/definitions/customOrganization07_622057fb770910001ec17da069440571" }, "customOrganization08": { "$ref": "#/definitions/customOrganization08_622057fb770910001ec17d95a3a80570" }, "customOrganization09": { "$ref": "#/definitions/customOrganization09_622057fb770910001ec17d90ad01056f" }, "program": { "$ref": "#/definitions/program_2c59cbf40d35100016cc7c5fce03022c" }, "jobProfile": { "$ref": "#/definitions/jobProfile_2c59cbf40d351000167c1db1aabc0227" }, "costCenter": { "$ref": "#/definitions/costCenter_2c59cbf40d3510001606811b605e0217" }, "location": { "$ref": "#/definitions/location_2c59cbf40d35100016cc7c6d9f47022d" }, "grant": { "$ref": "#/definitions/grant_2c59cbf40d351000165fee6359770223" }, "businessUnit": { "$ref": "#/definitions/businessUnit_2c59cbf40d3510001316b415768e0207" }, "position": { "$ref": "#/definitions/position_ca1fbf87fc9910000b3bdb0f333f0108" }, "region": { "$ref": "#/definitions/region_2c59cbf40d35100016cc7c5318a1022b" }, "fund": { "$ref": "#/definitions/fund_2c59cbf40d351000162afefff76e021b" }, "reportedQuantity": { "type": "number", "example": 8, "description": "The hours or units entered for a reported time block.", "x-workday-type": "Numeric" }, "gift": { "$ref": "#/definitions/gift_2c59cbf40d35100016462a876d4a021f" }, "status": { "$ref": "#/definitions/status_18442114504f100026d30c1460a50112" }, "comment": { "type": "string", "example": "This is a comment.", "description": "The comment associated with the reported time block.", "x-workday-type": "Text" }, "unit": { "$ref": "#/definitions/unit_18442114504f100026d30c2a38830114" }, "worker": { "$ref": "#/definitions/worker_18442114504f10001e10e2282255010a" }, "calendarDate": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date for a reported time block.", "x-workday-type": "Date" }, "timeEntryCode": { "$ref": "#/definitions/timeEntryCode_18442114504f100025df72b5b8260110" }, "projectRole": { "$ref": "#/definitions/projectRole_70b4c28387c3100012a4547f2bb74d82" }, "overrideRate": { "type": "number", "example": 3, "description": "The override rate for a reported time block.", "x-workday-type": "Numeric" }, "projectPlanPhase": { "$ref": "#/definitions/projectPlanPhase_7253d97923c710000914ca2463350030" }, "inTimeZone": { "$ref": "#/definitions/inTimeZone_d35ad574d80a10001a4eb54b4f670751" }, "outTimeZone": { "$ref": "#/definitions/outTimeZone_7250c62af41110001d4f4f6c58892419" }, "outReason": { "$ref": "#/definitions/outReason_5bebcdab469a1000249e2afbf6e7028f" }, "project": { "$ref": "#/definitions/project_8b25b2910fad100013106a9a0c950437" }, "doNotBill": { "type": "boolean", "example": true, "description": "The non-billable flag for a reported time block.", "x-workday-type": "Boolean" }, "projectPlanTask": { "$ref": "#/definitions/projectPlanTask_8b25b2910fad100013106a8d2cbc0436" }, "currency": { "$ref": "#/definitions/currency_622057fb7709100017b60484df4b03a4" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Worker Time Block" } } } ] }, "WorkdayReferenceId_workerTimeBlock": { "type": "string", "pattern": "^(Worker_Time_Block_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Worker_Time_Block_ID", "example": "Worker_Time_Block_ID=21002" }, "ResourceIdPathValue_workerTimeBlock": {}, "WorkdayReferenceId_workerTimeBlocks": { "type": "string", "pattern": "^(Worker_Time_Block_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Worker_Time_Block_ID", "example": "Worker_Time_Block_ID=21002" }, "ResourceIdPathValue_workerTimeBlocks": {}, "timeAttestationPromptView_6f40500c8ed010001f549d43b4360000": { "allOf": [ { "type": "object", "properties": { "order": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The order of the time attestation prompt.", "x-workday-type": "Text" }, "responses": { "type": "array", "description": "Time attestation responses for the time attestation prompt.", "items": { "$ref": "#/definitions/responses_2e3f0f6db44a100009672b63da580000" }, "x-workday-type": "Multi-instance" }, "blocking": { "type": "boolean", "example": true, "description": "The time attestation prompt is blocking the creation of the time clock event so that the worker can't check in or out.", "x-workday-type": "Boolean" }, "timeRemaining": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "A message indicating the time remaining on the worker's meal or break.", "x-workday-type": "Text" }, "requiresComment": { "type": "boolean", "example": true, "description": "A comment is required when creating the worker time attestation for the time attestation prompt.", "x-workday-type": "Boolean" }, "id": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "wid / id / reference id Pattern: ^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$", "maxLength": 36, "x-workday-type": "Text" }, "required": { "type": "boolean", "example": true, "description": "The time attestation prompt is required to be answered for the time clock event.", "x-workday-type": "Boolean" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "WorkdayReferenceId_timeClockEvents": { "type": "string", "pattern": "^(Time_Clock_Event_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Time_Clock_Event_ID", "example": "Time_Clock_Event_ID=21002" }, "ResourceIdPathValue_timeClockEvents": {}, "timeZone_3e3738572cc010001037f16af03b0017": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The time zone of the event. To retrieve a list of valid time zone IDs, use the GET /values/timeValues/workerTimeZone operation." }, "timeEntryCode_ee3d887ce441100008ae7446a1ce002f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The time entry code for the event. To retrieve a list of time entry codes, use the GET /values/timeTypes/timeEntryCodes operation, which returns the time entry codes that the given worker is eligible for on the given date." }, "projectPlanTask_ee3d887ce4411000085b1e9b8cbd0026": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The project plan task for the event. To retrieve a list of valid project plan task IDs, use the GET /values/timeTypes/projectPlanTasks operation, which you can filter by date, worker, and project." }, "project_ee3d887ce441100007fa4dd00ec0001d": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The project for the time clock event. To retrieve a list of valid project IDs, use the GET /values/timeTypes/projects operation, which you can filter by date and worker." }, "customWorktag08_28af701b8cb1100016ce4f2c19801297": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 8 for a time clock event." }, "customWorktag14_28af701b8cb1100018306ffbba3612cd": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 14 for a time clock event." }, "customWorktag04_28af701b8cb1100015bf87827a8f127b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 4 for a time clock event." }, "customWorktag12_28af701b8cb1100017abdeefe29112ba": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 12 for a time clock event." }, "customWorktag13_28af701b8cb1100017ff7d1fd47912c4": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 13 for a time clock event." }, "customWorktag09_28af701b8cb1100017027e18de2d12a0": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 9 for a time clock event." }, "customWorktag15_28af701b8cb11000188ce9acf40512d6": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 15 for a time clock event." }, "customWorktag01_28af701b8cb1100005a947a3a30e1257": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 1 for a time clock event." }, "customWorktag07_28af701b8cb11000165d1078efe9128d": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 7 for a time clock event." }, "customWorktag02_28af701b8cb1100006e238c0081f1260": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 2 for a time clock event." }, "customWorktag05_28af701b8cb1100015f2e2684a751284": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 5 for a time clock event." }, "customWorktag11_28af701b8cb11000177e498829db12b2": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 11 for a time clock event." }, "customWorktag06_28af701b8cb110001586eda6b6361272": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 6 for a time clock event." }, "customWorktag03_28af701b8cb11000071f314ba4b81269": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 3 for a time clock event." }, "customWorktag10_28af701b8cb110001740d27ff05812a9": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom worktag 10 for a time clock event." }, "allocationPool_a148c09459141000128f85c7e20a0000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The allocation pool worktag for a time clock event." }, "appropriation_a148c0945914100019bf73fe1e950000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The appropriation as worktag for a reported time block." }, "fund_2d6782d92d731000044e0f5ad06e0031": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The fund as worktag for a time clock event." }, "position_6899ff639e0b10001f57e90fbae10000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The position for the worker. This field is required if the worker has multiple positions. To retrieve a list of valid position IDs, use the GET /values/timeValues/positions operation, which you can filter by date and worker." }, "eventType_0a6f96054ac41000079a35410ed9001e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The type of time clock event.\n\nPossible values:\n* In, 3b6121e8f9804d6ab0065ebe212fc0fe\n* Out, a5b65f69843a456f800ae8277d1b95a1\n* Meal, f9a26196497a4ebb9899b6af9b79eb57\n* Break, cc5c9953e04047ada67fc848db5365ee" }, "region_0a6f96054ac41000076063a6b0ff0014": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The region as worktag for a time clock event." }, "customOrganization07_54bd0898dc9910000d3731974a2a0048": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 07 for a time clock event." }, "customOrganization02_54bd0898dc9910000bc4240d0d30001a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 02 for a time clock event." }, "customOrganization09_54bd0898dc9910000dd9ef603fef005a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 09 for a time clock event." }, "jobProfile_4cead304c6d910000a66bd72749f0032": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The job profile as worktag for a time clock event." }, "customOrganization10_54bd0898dc9910000e213be20f520063": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 10 for a time clock event." }, "customOrganization08_54bd0898dc9910000d6c2f9727900051": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 08 for a time clock event." }, "location_4cead304c6d910000a93ef699614003c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The location as worktag for a time clock event." }, "grant_4cead304c6d910000a3181cd95d10028": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The grant as worktag for a time clock event." }, "customOrganization06_54bd0898dc9910000cecaf1664fa003e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 06 for a time clock event." }, "customOrganization03_54bd0898dc9910000c0cc64e11d10023": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 03 for a time clock event." }, "gift_4cead304c6d910000a06d2f2d74c001e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The gift as worktag for a time clock event." }, "program_4cead304c6d9100009cf5aace0360014": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The program as worktag for a time clock event." }, "customOrganization01_a84de86d2c7b100004e23939907b0012": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 01 for a time clock event." }, "customOrganization04_54bd0898dc9910000c39a76b17c0002b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 04 for a time clock event." }, "customOrganization05_54bd0898dc9910000c70c52323dc0035": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The custom organization 05 for a time clock event." }, "currency_d5dca550f8fd1000091b129eb05c0088": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency for a check-in time clock event." }, "businessUnit_d5dca550f8fd10000706ddb31c160036": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The business unit worktag for a time clock event." }, "costCenter_d5dca550f8fd1000086abf265e8c0061": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The cost center as worktag for a time clock event." }, "worker_d5dca550f8fd10000531471b60ca0011": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker for the time clock event." }, "timeClockEventView_3e3738572cc010000fdfe310d0900010": { "allOf": [ { "type": "object", "properties": { "timeZone": { "$ref": "#/definitions/timeZone_3e3738572cc010001037f16af03b0017" }, "reference_ID": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Reference ID to use for lookups within our Workday Web Services.", "x-workday-type": "Text" }, "timeEntryCode": { "$ref": "#/definitions/timeEntryCode_ee3d887ce441100008ae7446a1ce002f" }, "projectPlanTask": { "$ref": "#/definitions/projectPlanTask_ee3d887ce4411000085b1e9b8cbd0026" }, "project": { "$ref": "#/definitions/project_ee3d887ce441100007fa4dd00ec0001d" }, "customWorktag08": { "$ref": "#/definitions/customWorktag08_28af701b8cb1100016ce4f2c19801297" }, "customWorktag14": { "$ref": "#/definitions/customWorktag14_28af701b8cb1100018306ffbba3612cd" }, "customWorktag04": { "$ref": "#/definitions/customWorktag04_28af701b8cb1100015bf87827a8f127b" }, "customWorktag12": { "$ref": "#/definitions/customWorktag12_28af701b8cb1100017abdeefe29112ba" }, "customWorktag13": { "$ref": "#/definitions/customWorktag13_28af701b8cb1100017ff7d1fd47912c4" }, "customWorktag09": { "$ref": "#/definitions/customWorktag09_28af701b8cb1100017027e18de2d12a0" }, "dateTime": { "type": "string", "format": "date", "example": "2026-09-19T07:00:00.000Z", "description": "The date and time of the event. The dateTime uses the ISO 8601 format: yyyy-mm-ddThh:mm:ss.sss", "x-workday-type": "Date" }, "customWorktag15": { "$ref": "#/definitions/customWorktag15_28af701b8cb11000188ce9acf40512d6" }, "customWorktag01": { "$ref": "#/definitions/customWorktag01_28af701b8cb1100005a947a3a30e1257" }, "customWorktag07": { "$ref": "#/definitions/customWorktag07_28af701b8cb11000165d1078efe9128d" }, "customWorktag02": { "$ref": "#/definitions/customWorktag02_28af701b8cb1100006e238c0081f1260" }, "customWorktag05": { "$ref": "#/definitions/customWorktag05_28af701b8cb1100015f2e2684a751284" }, "customWorktag11": { "$ref": "#/definitions/customWorktag11_28af701b8cb11000177e498829db12b2" }, "customWorktag06": { "$ref": "#/definitions/customWorktag06_28af701b8cb110001586eda6b6361272" }, "customWorktag03": { "$ref": "#/definitions/customWorktag03_28af701b8cb11000071f314ba4b81269" }, "customWorktag10": { "$ref": "#/definitions/customWorktag10_28af701b8cb110001740d27ff05812a9" }, "allocationPool": { "$ref": "#/definitions/allocationPool_a148c09459141000128f85c7e20a0000" }, "appropriation": { "$ref": "#/definitions/appropriation_a148c0945914100019bf73fe1e950000" }, "fund": { "$ref": "#/definitions/fund_2d6782d92d731000044e0f5ad06e0031" }, "overrideRate": { "type": "number", "example": 9999.999999, "description": "The override rate for a time clock event.", "x-workday-type": "Numeric" }, "position": { "$ref": "#/definitions/position_6899ff639e0b10001f57e90fbae10000" }, "eventType": { "$ref": "#/definitions/eventType_0a6f96054ac41000079a35410ed9001e" }, "region": { "$ref": "#/definitions/region_0a6f96054ac41000076063a6b0ff0014" }, "customOrganization07": { "$ref": "#/definitions/customOrganization07_54bd0898dc9910000d3731974a2a0048" }, "customOrganization02": { "$ref": "#/definitions/customOrganization02_54bd0898dc9910000bc4240d0d30001a" }, "customOrganization09": { "$ref": "#/definitions/customOrganization09_54bd0898dc9910000dd9ef603fef005a" }, "jobProfile": { "$ref": "#/definitions/jobProfile_4cead304c6d910000a66bd72749f0032" }, "customOrganization10": { "$ref": "#/definitions/customOrganization10_54bd0898dc9910000e213be20f520063" }, "customOrganization08": { "$ref": "#/definitions/customOrganization08_54bd0898dc9910000d6c2f9727900051" }, "location": { "$ref": "#/definitions/location_4cead304c6d910000a93ef699614003c" }, "grant": { "$ref": "#/definitions/grant_4cead304c6d910000a3181cd95d10028" }, "customOrganization06": { "$ref": "#/definitions/customOrganization06_54bd0898dc9910000cecaf1664fa003e" }, "customOrganization03": { "$ref": "#/definitions/customOrganization03_54bd0898dc9910000c0cc64e11d10023" }, "gift": { "$ref": "#/definitions/gift_4cead304c6d910000a06d2f2d74c001e" }, "program": { "$ref": "#/definitions/program_4cead304c6d9100009cf5aace0360014" }, "customOrganization01": { "$ref": "#/definitions/customOrganization01_a84de86d2c7b100004e23939907b0012" }, "customOrganization04": { "$ref": "#/definitions/customOrganization04_54bd0898dc9910000c39a76b17c0002b" }, "customOrganization05": { "$ref": "#/definitions/customOrganization05_54bd0898dc9910000c70c52323dc0035" }, "currency": { "$ref": "#/definitions/currency_d5dca550f8fd1000091b129eb05c0088" }, "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 time clock event.", "x-workday-type": "Text" }, "businessUnit": { "$ref": "#/definitions/businessUnit_d5dca550f8fd10000706ddb31c160036" }, "costCenter": { "$ref": "#/definitions/costCenter_d5dca550f8fd1000086abf265e8c0061" }, "worker": { "$ref": "#/definitions/worker_d5dca550f8fd10000531471b60ca0011" }, "workerTimeAttestations": { "type": "array", "description": "The worker time attestations for the time clock event. To create a worker time attestation, use the POST /workerTimeAttestation operation, which returns the ID of the time attestation.", "items": { "$ref": "#/definitions/workerTimeAttestations_01ccec103c01100018bf0dc9fb7d0000" }, "x-workday-type": "Multi-instance", "x-workday-confidence-level": "Production" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Time Clock Event" } } } ] }, "timeType_55171f9f3e0f1000ad84060306950000": { "allOf": [ { "type": "object", "properties": { "timeTypeCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The type of Time Type selected.", "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." } } } ] }, "timeTypeNested_0b8f058ceccd100092100f7f84980000": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/timeType_55171f9f3e0f1000ad84060306950000" } } } }, "timeAttestationPromptBasic_9749cd465123100025067f2b5c6c0000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Attestation Rule Prompt" } } } ] }, "timeAttestationResponseBasic_9749cd465123100025117a3a984c0000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Attestation Prompt Response (REST)" } } } ] }, "followupTimeAttestationPromptResponse_b70ff6bf8e65100011d26d03ac0e0000": { "allOf": [ { "type": "object", "properties": { "requiresComment": { "type": "boolean", "example": true, "description": "The time attestation response requires a comment when creating the followup worker time attestation.", "x-workday-type": "Boolean" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Attestation Prompt Response (REST)" } } } ] }, "responses_b70ff6bf8e65100011b4fc3912470002": { "allOf": [ { "$ref": "#/definitions/followupTimeAttestationPromptResponse_b70ff6bf8e65100011d26d03ac0e0000" }, { "properties": { "id": { "type": "string", "description": "The id for Time Attestation Prompt Response (REST)" } } } ] }, "countryDataForLocationData_af21e47ff7c01000092e0e4f9a22026e": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "country_af21e47ff7c01000092ecf4d7ad30270": { "allOf": [ { "$ref": "#/definitions/countryDataForLocationData_af21e47ff7c01000092e0e4f9a22026e" }, {} ], "description": "Returns the country from the primary address for the location." }, "locationDataJobView_6d3eb084b4c410002b5fa13f0c9d0056": { "allOf": [ { "type": "object", "properties": { "country": { "$ref": "#/definitions/country_af21e47ff7c01000092ecf4d7ad30270" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Location \nExample(s): Location_ID=Sample_Value" } } } ] }, "jobProfileJobView_fab4a151b24810000d511d61ee641262": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Job Profile \nExample(s): Job_Profile_ID=Sample_Value" } } } ] }, "jobWorkspaceData_1005157e3d631000144205466a6c13d3": { "allOf": [ { "type": "object", "properties": { "locationChain": { "type": "string", "example": "Sample Location Chain", "description": "Location chain including bread crumbs for location.", "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 Location \nExample(s): Location_ID=Sample_Value" } } } ] }, "jobTypeData_b8ac205877fd100005c3b50b74a30055": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "supervisoryOrganizationJobView_fab4a151b24810000d29746fb7e21259": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Supervisory Organization\\~ \nExample(s): Organization_Reference_ID=Sample_Value" } } } ] }, "location_b8ac205877fd10000ea91737c7da00a5": { "allOf": [ { "$ref": "#/definitions/locationDataJobView_6d3eb084b4c410002b5fa13f0c9d0056" }, {} ], "description": "The location associated with the filled position or position restrictions. When associated with position restrictions, the location returned is in this order: the location on the effective job requisition, hiring restrictions, or primary location of the supervisory organization." }, "jobProfile_b8ac205877fd10000ea9174f73c500aa": { "allOf": [ { "$ref": "#/definitions/jobProfileJobView_fab4a151b24810000d511d61ee641262" }, {} ], "description": "The job profile for the position." }, "workSpace_426ac445037110001b3eb91ddf6f0100": { "allOf": [ { "$ref": "#/definitions/jobWorkspaceData_1005157e3d631000144205466a6c13d3" }, {} ], "description": "The work space associated with the position." }, "jobType_b8ac205877fd10000ea91752f39c00ab": { "allOf": [ { "$ref": "#/definitions/jobTypeData_b8ac205877fd100005c3b50b74a30055" }, {} ], "description": "The position's job type which can be one of the following values: Primary, Additional Job, or International Assignment. If the position is not effective, no value will be returned. Primary and additional job are effective dated due to the Switch Primary Job business process. An international assignment cannot be switched to a be a primary job." }, "supervisoryOrganization_b8ac205877fd10000ea91743659800a7": { "allOf": [ { "$ref": "#/definitions/supervisoryOrganizationJobView_fab4a151b24810000d29746fb7e21259" }, {} ], "description": "The supervisory organization for the position." }, "jobDataForWorker_b8ac205877fd10000ea91719a02a00a2": { "allOf": [ { "type": "object", "properties": { "location": { "$ref": "#/definitions/location_b8ac205877fd10000ea91737c7da00a5" }, "jobProfile": { "$ref": "#/definitions/jobProfile_b8ac205877fd10000ea9174f73c500aa" }, "workSpace": { "$ref": "#/definitions/workSpace_426ac445037110001b3eb91ddf6f0100" }, "businessTitle": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The business title for the position.", "x-workday-type": "Text" }, "jobType": { "$ref": "#/definitions/jobType_b8ac205877fd10000ea91752f39c00ab" }, "supervisoryOrganization": { "$ref": "#/definitions/supervisoryOrganization_b8ac205877fd10000ea91743659800a7" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Position \nExample(s): Position_ID=Sample_Value" } } } ] }, "personDataView_be343791f59d100028d6a277ca8a0017": { "allOf": [ { "type": "object", "properties": { "phone": { "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 primary public work phone number for the worker.", "x-workday-type": "Text" }, "email": { "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 public primary work email address for the worker.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "The id for Person" } } } ] }, "additionalJobs_352c3a97ecd51000353cba4ccc1c0043": { "allOf": [ { "$ref": "#/definitions/jobDataForWorker_b8ac205877fd10000ea91719a02a00a2" }, { "properties": { "id": { "type": "string", "description": "The id for Position \nExample(s): Position_ID=Sample_Value" } } } ] }, "timeTotal_c649d8a6912a10000f116cb2a7f800a8": { "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": "Contains the label for this total calculation.", "x-workday-type": "Text" }, "totalNumber": { "type": "integer", "example": "99", "description": "Contains the ordered number of this total calculation.", "x-workday-type": "Numeric" }, "quantity": { "type": "number", "example": 100000000000, "description": "Contains the calculated sum for this total.", "x-workday-type": "Numeric" } } } ] }, "position_3b42645699ce10001c8ebcc3985c5497": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Contains Position for Time Review Event if Independent Events for Multiple Jobs is enabled on the Time Entry Template." }, "project_3b42645699ce10001ddee91b0f0257ff": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Contains \\~Project\\~ for Time Review Event if Independent Events for \\~Project\\~ is enabled on the Time Entry Template." }, "status_3b42645699ce10001ebd1d70a8485965": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Contains the current status of the business process. For example: Successfully Completed, Denied, Terminated." }, "timeReviewEventView_025a35898dab10000cdaad8649b3176d": { "allOf": [ { "type": "object", "properties": { "position": { "$ref": "#/definitions/position_3b42645699ce10001c8ebcc3985c5497" }, "project": { "$ref": "#/definitions/project_3b42645699ce10001ddee91b0f0257ff" }, "status": { "$ref": "#/definitions/status_3b42645699ce10001ebd1d70a8485965" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Review Event" } } } ] }, "timeReviewEvents_025a35898dab10000cce202b890c1722": { "allOf": [ { "$ref": "#/definitions/timeReviewEventView_025a35898dab10000cdaad8649b3176d" }, { "properties": { "id": { "type": "string", "description": "The id for Time Review Event" } } } ] }, "calculationTagBasic_3439b41098d9100019556994fc3100f9": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Calculation Tag" } } } ] }, "currency_aeb57ddfdb12100015833e596d9f016a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The calculated currency for a time block." }, "calculatedInTimeZone_6120704a618910000d26a6972d9501f4": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The calculated in time zone for a time block." }, "calculationTags_3439b41098d9100018b3fcf61bf500f2": { "allOf": [ { "$ref": "#/definitions/calculationTagBasic_3439b41098d9100019556994fc3100f9" }, { "properties": { "id": { "type": "string", "description": "The id for Time Calculation Tag" } } } ] }, "calculatedOutTimeZone_b29a4f3cb4f210000c67c9b4e0420143": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The calculated out time zone for a time block." }, "calculatedTimeBlockView_3439b41098d9100018b3fccee93900f1": { "allOf": [ { "type": "object", "properties": { "overrideRate": { "type": "number", "example": 3.3, "description": "The calculated override rate for a time block.", "x-workday-type": "Numeric" }, "shiftDate": { "type": "string", "format": "date", "example": "2019-11-11T08:00:00.000Z", "description": "The shift date for a time block.", "x-workday-type": "Date" }, "calculatedQuantity": { "type": "number", "example": 20, "description": "The calculated hours or units for a time block.", "x-workday-type": "Numeric" }, "currency": { "$ref": "#/definitions/currency_aeb57ddfdb12100015833e596d9f016a" }, "calculatedDate": { "type": "string", "format": "date", "example": "2019-11-05T08:00:00.000Z", "description": "The calculated date for a time block.", "x-workday-type": "Date" }, "calculatedInTimeZone": { "$ref": "#/definitions/calculatedInTimeZone_6120704a618910000d26a6972d9501f4" }, "calculationTags": { "type": "array", "description": "Calculation Tags generated by Time Calculations. Blank if not a Calculated Time Block.", "items": { "$ref": "#/definitions/calculationTags_3439b41098d9100018b3fcf61bf500f2" }, "x-workday-type": "Multi-instance" }, "calendarDate": { "type": "string", "format": "date", "example": "2019-11-12T17:00:00.000Z", "description": "The calendar date for a time block.", "x-workday-type": "Date" }, "calculatedOutTimeZone": { "$ref": "#/definitions/calculatedOutTimeZone_b29a4f3cb4f210000c67c9b4e0420143" }, "id": { "type": "string", "description": "The id for Time Block" } } } ] }, "calculatedTimeDetails_4a93e2d0dc73100013126e99abfd02b9": { "allOf": [ { "$ref": "#/definitions/calculatedTimeBlockView_3439b41098d9100018b3fccee93900f1" }, { "properties": { "id": { "type": "string", "description": "The id for Time Block" } } } ] }, "timeAttestationPromptResponse_1fe767efce4b10001b70b7bb0e860000": { "allOf": [ { "type": "object", "properties": { "order": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The order of the time attestation response.", "x-workday-type": "Text" }, "hasFollowupPrompt": { "type": "boolean", "example": true, "description": "The time attestation response has a followup time attestation prompt that requirs an answer.", "x-workday-type": "Boolean" }, "requiresComment": { "type": "boolean", "example": true, "description": "The time attestation response requires a comment when creating the worker time attestation.", "x-workday-type": "Boolean" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Attestation Prompt Response (REST)" } } } ] }, "responses_2e3f0f6db44a100009672b63da580000": { "allOf": [ { "$ref": "#/definitions/timeAttestationPromptResponse_1fe767efce4b10001b70b7bb0e860000" }, { "properties": { "id": { "type": "string", "description": "The id for Time Attestation Prompt Response (REST)" } } } ] }, "workerTimeAttestationViewOrder_ac5fdd0ce16b100032c540a9ec160000": { "allOf": [ { "type": "object", "properties": { "order": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The order of the worker time attestation.", "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 \\~Worker\\~ Time Attestation" } } } ] }, "workerTimeAttestations_01ccec103c01100018bf0dc9fb7d0000": { "allOf": [ { "$ref": "#/definitions/workerTimeAttestationViewOrder_ac5fdd0ce16b100032c540a9ec160000" }, { "properties": { "id": { "type": "string", "description": "The id for \\~Worker\\~ Time Attestation" } } } ] } } }