Cases

Maintains a record of cases that a user has access to view.This table supports issue tracking, employee relations cases, IT service requests, and customer support interactions.

Workday Resource Information

Retrieves a list of case details that the user is secured to view. Case details include: title, detailed message, case ID, status, creation date, case link, assignee, confidential, about, by, for, type, and serviceTeam.

Secured by: Help Case Data+TG, Self Service: Help Case Management+TG

Scope: Help

Aggregate Fields

The component represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

Attachments_Aggregate

[{
  contentType: { /* Content type of the attachment */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  descriptor: Text /* A preview of the instance */
  fileLength: Numeric /* File length of the attachment */
  fileName: Text /* File name of the attachment */
  id: Text /* \~Case\~ Attachment ID. */
}]

QuestionnaireResponses_QuestionnaireAnswers_Aggregate

[{
  answerDate: Date /* The answer in a date format. */
  answerMultipleChoices: [{
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }]
  answerNumeric: Numeric /* The answer in a numeric format. */
  answerText: Text /* The text answer for a questionnaire. */
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
  questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  questionnaireAttachments: [{
      contentType: { /* Content type of the attachment */
         -descriptor: Text /* A description of the instance */
         -href: Text /* A link to the instance */
         *id: Text /* wid / id / reference id */
      }
      descriptor: Text /* A preview of the instance */
      fileLength: Numeric /* File length of the attachment */
      fileName: Text /* File name of the attachment */
      id: Text /* Id of the instance */
  }]
}]

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The unique identifier (Id) for the case instance. This Id allows for distinct tracking, retrieval, and management of cases within the system.
AboutWorker_Id	String	False	The unique Id for the worker that the case is about. This Id ensures that all case-related activities and updates are correctly linked to the designated worker.
About_Descriptor	String	False	A human-readable summary of the case subject. This summary provides a brief but clear reference to the individual or entity involved in the case.
About_Id	String	False	The unique Id for the case subject. This Id ensures consistency in system records and supports case tracking and reporting.
About_Person_Descriptor	String	False	A human-readable summary of the person that the case is about. This summary provides additional clarity by displaying key identifying details of the individual.
About_Person_Href	String	False	A direct link to the instance of the person associated with the case. This link enables programmatic access to fetch detailed information about the individual involved.
About_Person_Id	String	False	The unique Id for the person that the case is about. This Id ensures that system queries and reports accurately reference the correct individual.
Assignee_Descriptor	String	False	A human-readable summary of the case assignee. This summary helps users quickly identify the person or team responsible for managing the case.
Assignee_Id	String	False	The unique Id for the assignee of the case. This Id ensures proper assignment, delegation, and resolution tracking.
Assignee_Person_Descriptor	String	False	A human-readable summary of the assignee responsible for managing the case. This descriptor includes essential details to help users recognize the assigned worker.
Assignee_Person_Href	String	False	A direct link to the assignee's instance. This link provides an easy way to navigate to the assignee’s profile or additional case-related information.
Assignee_Person_Id	String	False	The unique Id for the assignee of the case. This Id ensures that cases are correctly routed to the responsible worker for action.
Attachments_Aggregate	String	False	A collection of attachments added during case creation. These files can include supporting documents, images, or other relevant materials for case resolution.
By_Descriptor	String	False	A human-readable summary of the person who created the case. This summary provides insight into the requestor's identity for better case tracking.
By_ExternalCreator_Email	String	False	The email address of the external case creator. This contact information facilitates communication and case follow-ups with external submitters.
By_ExternalCreator_Id	String	False	The unique Id for the external case creator. This Id helps track cases that originate from individuals outside the organization.
By_ExternalCreator_Name	String	False	The name of the external case creator, often appended with 'External' or a note indicating a purged record. This naming convention helps differentiate external requests from internal ones.
By_Id	String	False	The unique Id for the individual who created the case. This Id ensures precise tracking of case ownership and history.
By_Worker_Descriptor	String	False	A human-readable summary of the worker who created the case. This descriptor aids in recognizing the case initiator without needing additional lookups.
By_Worker_Id	String	False	The unique Id for the worker who initiated the case. This Id supports tracking and reporting on cases created by employees.
By_Worker_Person_Descriptor	String	False	A human-readable summary of the worker who created the case. This descriptor provides useful context about the requestor’s role or position.
By_Worker_Person_Href	String	False	A direct link to the instance of the worker who created the case. This link enables seamless navigation to the requestor’s profile.
By_Worker_Person_Id	String	False	The unique Id for the worker who created the case. This Id ensures that employee-initiated cases are correctly assigned and managed.
CaseID	String	False	The unique Id assigned to the case. This Id is crucial for case tracking, auditing, and referencing within the system.
CaseLink	String	False	A direct link to view the case in Workday. This Uniform Resource Locator (URL) allows users to access full case details and take necessary actions.
CaseReopenDetails_CaseReopenDueDate	String	False	The deadline for reopening the case. This date sets the last possible day when a worker can request a case review or reactivation.
CaseReopenDetails_CaseReopenStatus	Bool	False	Indicates whether the case can be reopened by the worker. A value of 'true' means the worker still has the option to request further action.
CaseType_Id	String	False	The unique Id for the case type. This Id categorizes the case based on its nature, such as HR, IT, or compliance-related issues.
Confidential	Bool	False	Indicates whether the case is marked as confidential. A value of 'true' ensures that access is limited to authorized personnel only.
ContextInstance_Id	String	False	wid / id / reference id
CreationDate	Datetime	False	The date and time when the case was created. This timestamp serves as a historical record and helps track response and resolution times.
DetailedMessage	String	False	The detailed description of the case. This field captures all relevant information, including the issue, request, or inquiry details.
ElementContent_Id	String	False	wid / id / reference id
ForExternalCreator_Id	String	False	The unique Id for the external creator associated with the case. This Id distinguishes cases initiated by external individuals or organizations.
ForWorker_Id	String	False	The unique Id for the worker for whom the case was created. This Id ensures that the case is accurately assigned to the correct employee.
For_Descriptor	String	False	A human-readable summary of the worker or external creator for whom the case was created. This descriptor provides an at-a-glance reference for users handling the case.
For_ExternalCreator_Email	String	False	The email address of the external creator associated with the case. This contact information allows for follow-ups and communications regarding the case.
For_ExternalCreator_Id	String	False	The unique Id for the external creator associated with the case. This Id links the case back to its originating party.
For_ExternalCreator_Name	String	False	The name of the external creator, often including 'External' in parentheses or a note indicating a purged record. This naming convention differentiates external cases from internal ones.
For_Id	String	False	The unique Id for the worker or external creator associated with the case. This Id ensures precise case tracking and accountability.
For_Worker_Descriptor	String	False	A human-readable summary of the worker for whom the case was created. This descriptor provides additional insight into the recipient’s role or involvement in the case.
For_Worker_Id	String	False	The unique Id for the worker for whom the case was created. This Id helps link the case to the appropriate individual for tracking and resolution.
For_Worker_Person_Descriptor	String	False	A human-readable summary of the worker for whom the case was created. This descriptor provides a brief but informative overview of the worker involved.
For_Worker_Person_Href	String	False	A direct link to the worker’s instance. This link allows for quick navigation to detailed information about the worker associated with the case.
For_Worker_Person_Id	String	False	The unique Id for the worker associated with the case. This Id ensures that cases are assigned correctly and consistently.
FormattedCreationDate	String	False	The formatted creation date of the case, including the year, month, day, hour, and minute. This format ensures consistency with the processing user's locale and timezone.
QuestionnaireHolder_Id	String	False	The unique Id for the questionnaire holder associated with the case. This Id ensures that the questionnaire responses remain linked to the correct case.
QuestionnaireResponses_Descriptor	String	False	A human-readable summary of the questionnaire responses for the case. This descriptor provides a high-level view of the responses collected.
QuestionnaireResponses_Id	String	False	The unique Id for the questionnaire responses associated with the case. This Id is used to track and manage responses within the system.
QuestionnaireResponses_QuestionnaireAnswers_Aggregate	String	False	A collection of all answers submitted in response to a questionnaire. These responses provide critical information for case evaluation and resolution.
QuestionnaireResponses_QuestionnaireTargetContext_Id	String	False	The unique Id for the context in which the questionnaire was targeted. This Id helps determine the scope and relevance of the collected responses.
QuestionnaireResponses_QuestionnaireTarget_Id	String	False	The unique Id for the specific questionnaire target. This Id ensures that responses are properly associated with the intended questionnaire.
SatisfactionSurvey_Active	Bool	False	Indicates whether the case has an active satisfaction survey. A value of 'true' means that feedback can still be provided by the user.
SatisfactionSurvey_Directive	String	False	The directive text displayed in the case satisfaction survey. This text offers guidance on how the survey should be completed.
SatisfactionSurvey_Results_Comment	String	False	The comment provided in response to the case satisfaction survey. This feedback allows users to elaborate on their experience with the case.
SatisfactionSurvey_Results_FormattedCreationDate	String	False	The formatted creation date of the case satisfaction survey response, including the year, month, day, hour, and minute. This format ensures clarity for reporting and analysis.
SatisfactionSurvey_Results_Id	String	False	The unique Id for the case satisfaction survey response. This Id links feedback to the appropriate case record.
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Descriptor	String	False	A human-readable summary of the questionnaire associated with the case satisfaction survey response. This descriptor provides insight into the survey's purpose and content.
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Href	String	False	A direct link to the questionnaire instance associated with the case satisfaction survey response. This link facilitates easy access to survey details.
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Id	String	False	The unique Id for the questionnaire associated with the case satisfaction survey response. This Id ensures that feedback is recorded under the correct questionnaire.
SatisfactionSurvey_Results_Score_Description	String	False	A description of the case satisfaction survey response score. This description helps interpret the numerical rating given by the respondent.
SatisfactionSurvey_Results_Score_Number	Decimal	False	The numeric score given in response to the case satisfaction survey. This score quantifies user satisfaction with the resolution of the case.
SatisfactionSurvey_Task	String	False	Indicates whether the satisfaction survey has been dismissed. A value of 'true' means that the user has chosen not to complete the survey.
ServiceTeam_Descriptor	String	False	A human-readable summary of the service team handling the case. This descriptor provides details about the team responsible for resolving the issue.
ServiceTeam_Href	String	False	A direct link to the service team instance. This link enables users to retrieve additional information about the assigned service team.
ServiceTeam_Id	String	False	The unique Id for the service team responsible for the case. This Id ensures accurate case assignment within the system.
Source_Id	String	False	The unique Id for the source of the case. This Id identifies where the case originated, such as from a user, system, or external entity.
Status_Descriptor	String	False	A human-readable summary of the current status of the case. This descriptor provides insight into whether the case is open, resolved, or pending action.
Status_Id	String	False	The unique Id for the status of the case. This Id ensures that the system correctly tracks changes in the case’s status.
Title	String	False	The title of the case. This title serves as a brief summary of the issue or request that the case addresses.
Type_Confidential	Bool	False	Indicates whether the case type is confidential. A value of 'true' restricts access to authorized users only.
Type_Description	String	False	A description of the case type. This description provides additional context about the nature or category of the case.
Type_Id	String	False	The unique Id for the case type. This Id categorizes the case based on its purpose or classification.
Type_Inactive	Bool	False	Indicates whether the case type is inactive. A value of 'true' means that this case type is no longer actively used.
Type_Name	String	False	The display Id for the case type. This name represents the case type in a user-friendly format.
Type_ServiceCategory_Description	String	False	A description of the service category associated with the case type. This description provides details about the type of service the case falls under.
Type_ServiceCategory_Id	String	False	The unique Id for the service category associated with the case type. This Id ensures proper classification of service types.
Type_ServiceCategory_Name	String	False	The name of the service category associated with the case type. This name represents the category of service in a way that is easy to understand.
UiTask_Id	String	False	wid / id / reference id
Desc_Prompt	Bool	False	Indicates whether results should be sorted in descending order. A value of 'true' ensures that the most recent cases appear first.
MyCases_Prompt	Bool	False	Retrieves cases that are owned by the processing user. This filter helps users see only the cases assigned to them.
OpenCases_Prompt	Bool	False	Retrieves open cases and cases that were resolved or canceled within the last seven days. This filter helps users focus on recent case activity.
Sort_Prompt	String	False	Determines the field used for sorting case results. The default sorting field is 'creationDate'. Currently, only sorting by 'creationDate' is supported.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.

Build 25.0.9434