Cases

Retrieves a list of cases that the user is secured to view.

Workday Resource Information

Retrieves a case with the specified ID. 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 provider 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.

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 */
     *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. */
     *id: Text /* wid / id / reference id */
  }
  questionnaireAttachments: [{
      contentType: { /* Content type of the attachment */
         *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	Id of the instance
AboutWorker_Id	String	False	wid / id / reference id
About_Descriptor	String	False	A preview of the instance
About_Id	String	False	Id of the instance
About_Person_Descriptor	String	False	A description of the instance
About_Person_Href	String	False	A link to the instance
About_Person_Id	String	False	wid / id / reference id
Assignee_Descriptor	String	False	A preview of the instance
Assignee_Id	String	False	Id of the instance
Assignee_Person_Descriptor	String	False	A description of the instance
Assignee_Person_Href	String	False	A link to the instance
Assignee_Person_Id	String	False	wid / id / reference id
Attachments_Aggregate	String	False	Case Creation Attachments.
By_Descriptor	String	False	A preview of the instance
By_ExternalCreator_Email	String	False	External Case Creator Email.
By_ExternalCreator_Id	String	False	Id of the instance
By_ExternalCreator_Name	String	False	External Case Creator Name and External in Parenthesis or Purged External Case Creator text.
By_Id	String	False	Id of the instance
By_Worker_Descriptor	String	False	A preview of the instance
By_Worker_Id	String	False	Id of the instance
By_Worker_Person_Descriptor	String	False	A description of the instance
By_Worker_Person_Href	String	False	A link to the instance
By_Worker_Person_Id	String	False	wid / id / reference id
CaseID	String	False	Case ID.
CaseLink	String	False	The link to view the Case.
CaseReopenDetails_CaseReopenDueDate	String	False	The details for the reopening of a case. This includes whether a worker can reopen a case and the last date that a worker can reopen a case.
CaseReopenDetails_CaseReopenStatus	Bool	False	True if a worker can reopen a case.
CaseType_Id	String	False	wid / id / reference id
Confidential	Bool	False	If true, the case is confidential.
CreationDate	Datetime	False	The date that the case was created on.
DetailedMessage	String	False	The description of the case.
ForExternalCreator_Id	String	False	wid / id / reference id
ForWorker_Id	String	False	wid / id / reference id
For_Descriptor	String	False	A preview of the instance
For_ExternalCreator_Email	String	False	External Case Creator Email.
For_ExternalCreator_Id	String	False	Id of the instance
For_ExternalCreator_Name	String	False	External Case Creator Name and External in Parenthesis or Purged External Case Creator text.
For_Id	String	False	Id of the instance
For_Worker_Descriptor	String	False	A preview of the instance
For_Worker_Id	String	False	Id of the instance
For_Worker_Person_Descriptor	String	False	A description of the instance
For_Worker_Person_Href	String	False	A link to the instance
For_Worker_Person_Id	String	False	wid / id / reference id
FormattedCreationDate	String	False	The creation date of the case formatted to include the year, month, day, hour and minute. The date format depends on the processing user's locale and uses the user's timezone.
QuestionnaireHolder_Id	String	False	wid / id / reference id
QuestionnaireResponses_Descriptor	String	False	A preview of the instance
QuestionnaireResponses_Id	String	False	Id of the instance
QuestionnaireResponses_QuestionnaireAnswers_Aggregate	String	False	The set of answers for a questionnaire.
QuestionnaireResponses_QuestionnaireTargetContext_Id	String	False	wid / id / reference id
QuestionnaireResponses_QuestionnaireTarget_Id	String	False	wid / id / reference id
SatisfactionSurvey_Active	Bool	False	If true, the case has an active satisfaction survey
SatisfactionSurvey_Directive	String	False	Returns the Survey Directive text for the Satisfaction Survey.
SatisfactionSurvey_Results_Comment	String	False	Case satisfaction survey response comment.
SatisfactionSurvey_Results_FormattedCreationDate	String	False	The creation date of the case satisfaction survey response formatted to include the year, month, day, hour and minute. The date format depends on the processing user's locale and uses the user's timezone.
SatisfactionSurvey_Results_Id	String	False	Id of the instance
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Descriptor	String	False	A description of the instance
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Href	String	False	A link to the instance
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Id	String	False	wid / id / reference id
SatisfactionSurvey_Results_Score_Description	String	False	Description of the case satisfaction survey response score.
SatisfactionSurvey_Results_Score_Number	Decimal	False	Score for the case satisfaction survey response.
SatisfactionSurvey_Task	String	False	If true, the Satisfaction Survey has been dismissed.
ServiceTeam_Descriptor	String	False	A description of the instance
ServiceTeam_Href	String	False	A link to the instance
ServiceTeam_Id	String	False	wid / id / reference id
Source_Id	String	False	wid / id / reference id
Status_Descriptor	String	False	A preview of the instance
Status_Id	String	False	Id of the instance
Title	String	False	The title of the case.
Type_Confidential	Bool	False	Case type confidential flag for REST service.
Type_Description	String	False	Case Type Description.
Type_Id	String	False	Id of the instance
Type_Inactive	Bool	False	True if the case type is inactive.
Type_Name	String	False	Returns the display id of the instance.
Type_ServiceCategory_Description	String	False	The description of the service category.
Type_ServiceCategory_Id	String	False	Id of the instance
Type_ServiceCategory_Name	String	False	The name of the service category.
Desc_Prompt	Bool	False	If true, sorts results in descending order.
MyCases_Prompt	Bool	False	Retrieves cases owned by the processing user.
OpenCases_Prompt	Bool	False	Retrieves open cases and cases that were resolved or canceled less than 7 days ago.
Sort_Prompt	String	False	The field to sort results by. The default is creationDate. Note: Currently supports creationDate only.

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

Build 24.0.9175