CasesTimeline
Retrieves a list of comment timeline items for a case.
Workday Resource Information
Retrieves a timeline item for a case with the specified timeline ID. Comment timeline items include comments and associated attachments. Action timeline items include an action with an action text. Creation timeline items include a description, associated attachments and a questionnaire answer if applicable.Secured by: REST API Public
Contains attachment(s)
Aggregate Fields
The cmdlet 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. */
}]
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
No description available. |
| Cases_Id [KEY] | String | False |
The Workday ID of the Cases that owns this. |
| Attachments_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Case Timeline Item (Derived) has Case Attachment (Derived) [RL]. |
| Comment_Content | String | False |
Supported for: SELECT, INSERT. returns rich text comment for a Case |
| Comment_TextBody | String | False |
Supported for: SELECT, INSERT. returns normal text comment for a Case |
| CreationDate | Datetime | False |
Supported for: SELECT. The date that the case timeline item was created on. |
| Description | String | False |
Supported for: SELECT. Used by the Case Creation Timeline Item, contains the detailed message written by case creators. |
| FormattedCreationDate | String | False |
Supported for: SELECT. The creation date of the timeline item 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. |
| Guidance_KbArticle_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
| Guidance_KbArticle_Id | String | False |
Supported for: SELECT. Id of the instance |
| Guidance_UiTask_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
| Guidance_UiTask_Id | String | False |
Supported for: SELECT. Id of the instance |
| Guidance_UiTask_Url | String | False |
Supported for: SELECT. Returns the fully qualified URL for the given Task |
| QuestionnaireResponse_Questionnaire_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
| QuestionnaireResponse_Questionnaire_Href | String | False |
Supported for: SELECT. A link to the instance |
| QuestionnaireResponse_Questionnaire_Id | String | False |
Supported for: SELECT. wid / id / reference id |
| SubmittedBy_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
| SubmittedBy_ExternalCreator_Email | String | False |
Supported for: SELECT. External Case Creator Email. |
| SubmittedBy_ExternalCreator_Id | String | False |
Supported for: SELECT. Id of the instance |
| SubmittedBy_ExternalCreator_Name | String | False |
Supported for: SELECT. External Case Creator Name and External in Parenthesis or Purged External Case Creator text. |
| SubmittedBy_Id | String | False |
Supported for: SELECT. Id of the instance |
| SubmittedBy_Worker_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
| SubmittedBy_Worker_Id | String | False |
Supported for: SELECT. Id of the instance |
| SubmittedBy_Worker_Person_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
| SubmittedBy_Worker_Person_Href | String | False |
Supported for: SELECT. A link to the instance |
| SubmittedBy_Worker_Person_Id | String | False |
Supported for: SELECT. wid / id / reference id |
| Type_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
| Type_Id | String | False |
Supported for: SELECT. Id of the instance |
| Desc_Prompt | Bool | False |
Only used when a Cases_Id filter is not provided. If true, sorts results in descending order. |
| MyCases_Prompt | Bool | False |
Only used when a Cases_Id filter is not provided. Retrieves cases owned by the processing user. |
| OpenCases_Prompt | Bool | False |
Only used when a Cases_Id filter is not provided. Retrieves open cases and cases that were resolved or canceled less than 7 days ago. |
| Sort_Prompt | String | False |
Only used when a Cases_Id filter is not provided. The field to sort results by. The default is creationDate. Note: Currently supports creationDate only. |